Skip to content

Commit 225c011

Browse files
committed
chore: mcp-inspector docs
1 parent fb0a14b commit 225c011

File tree

3 files changed

+8
-15
lines changed

3 files changed

+8
-15
lines changed

DEVELOPING.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -165,24 +165,18 @@ Quick options; see `packages/mcp/DEVELOPING.md` for full details and troubleshoo
165165
yarn workspace @salesforce/mcp build
166166
```
167167

168-
- Option A: start via the server’s start script (spawns MCP Inspector against the CLI bin):
169-
170-
```bash
171-
yarn workspace @salesforce/mcp start
172-
```
173-
174-
- Option B: use MCP Inspector (browser) directly against the built server (run inside the server package):
168+
- Option A: use MCP Inspector (browser) directly against the built server (run inside the server package):
175169

176170
```bash
177171
cd packages/mcp
178-
mcp-inspector node lib/index.js --orgs DEFAULT_TARGET_ORG
172+
mcp-inspector node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG
179173
```
180174

181-
- Option C: use MCP Inspector CLI mode against the server’s CLI entry (run inside the server package):
175+
- Option B: use MCP Inspector CLI mode against the server’s CLI entry (run inside the server package):
182176

183177
```bash
184178
cd packages/mcp
185-
mcp-inspector --cli node bin/run.js --orgs DEFAULT_TARGET_ORG --method tools/list
179+
mcp-inspector --cli node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG --method tools/list
186180
```
187181

188182
Notes:

packages/mcp/DEVELOPING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Then follow the steps for the type of testing you want to do: from the browser o
7878
### Browser
7979

8080
1. Build the local server: `yarn build`.
81-
2. Start the MCP Inspector server: `mcp-inspector node lib/index.js --orgs DEFAULT_TARGET_ORG`.
81+
2. Start the MCP Inspector server: `mcp-inspector node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG`.
8282
3. If successful, open the specified localhost URL in your browser. In this example it's `http://127.0.0.1:6274`:
8383

8484
```
@@ -101,7 +101,7 @@ Then follow the steps for the type of testing you want to do: from the browser o
101101
This example calls the `run_soql_query` tool from the context of a Salesforce DX project:
102102

103103
```shell
104-
mcp-inspector --cli node bin/run.js --orgs DEFAULT_TARGET_ORG \
104+
mcp-inspector --cli node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG \
105105
--method tools/call \
106106
--tool-name run_soql_query \
107107
--tool-arg query="select id from account limit 5" \
@@ -123,7 +123,7 @@ ata/v63.0/sobjects/Account/001DK00001BFbHbYAL\"\n },\n \"Id\": \"001DK
123123
Learn more about each tool argument by looking at its definition in the code, the MCP Inspector browser UI, or by listing all tools using the MCP Inspector CLI. For example:
124124

125125
```shell
126-
mcp-inspector --cli node bin/run.js --orgs DEFAULT_TARGET_ORG --method tools/list
126+
mcp-inspector --cli node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG --method tools/list
127127
```
128128

129129
### Unit Tests
@@ -146,7 +146,7 @@ You can use the VS Code debugger with the MCP Inspector CLI to step through the
146146
Here's an example of calling the `run_soql_query` tool:
147147

148148
```shell
149-
MCP_SERVER_REQUEST_TIMEOUT=120000 mcp-inspector --cli node --inspect-brk bin/run.js -o DEFAULT_TARGET_ORG --no-telemetry --method tools/call \
149+
MCP_SERVER_REQUEST_TIMEOUT=120000 mcp-inspector --cli node --inspect-brk bin/run.js --toolsets all -o DEFAULT_TARGET_ORG --no-telemetry --method tools/call \
150150
--tool-name run_soql_query \
151151
--tool-arg directory="/path/to/sfdx-project" \
152152
--tool-arg query="select name from Property__c order by name asc" \

packages/mcp/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
"format": "wireit",
1717
"link-check": "wireit",
1818
"lint": "wireit",
19-
"start": "yarn build && npm link && mcp-inspector sf-mcp-server",
2019
"test": "wireit",
2120
"test:only": "wireit"
2221
},

0 commit comments

Comments
 (0)