Skip to content

@W-21448393 mcp-inspector docs #401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
soridalac merged 2 commits into from
Mar 5, 2026
Merged

@W-21448393 mcp-inspector docs #401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
225c011
chore: mcp-inspector docs
iowillhoit Mar 4, 2026
cf7c463
Merge branch 'main' into ew/mcp-inspector-docs
soridalac Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 4 additions & 10 deletions DEVELOPING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,24 +165,18 @@ Quick options; see `packages/mcp/DEVELOPING.md` for full details and troubleshoo
yarn workspace @salesforce/mcp build
```

- Option A: start via the server’s start script (spawns MCP Inspector against the CLI bin):

```bash
yarn workspace @salesforce/mcp start
```

- Option B: use MCP Inspector (browser) directly against the built server (run inside the server package):
- Option A: use MCP Inspector (browser) directly against the built server (run inside the server package):

```bash
cd packages/mcp
mcp-inspector node lib/index.js --orgs DEFAULT_TARGET_ORG
mcp-inspector node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG
```

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

```bash
cd packages/mcp
mcp-inspector --cli node bin/run.js --orgs DEFAULT_TARGET_ORG --method tools/list
mcp-inspector --cli node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG --method tools/list
```

Notes:
Expand Down
8 changes: 4 additions & 4 deletions packages/mcp/DEVELOPING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Then follow the steps for the type of testing you want to do: from the browser o
### Browser

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

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

```shell
mcp-inspector --cli node bin/run.js --orgs DEFAULT_TARGET_ORG \
mcp-inspector --cli node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG \
--method tools/call \
--tool-name run_soql_query \
--tool-arg query="select id from account limit 5" \
Expand All @@ -123,7 +123,7 @@ ata/v63.0/sobjects/Account/001DK00001BFbHbYAL\"\n },\n \"Id\": \"001DK
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:

```shell
mcp-inspector --cli node bin/run.js --orgs DEFAULT_TARGET_ORG --method tools/list
mcp-inspector --cli node bin/run.js --toolsets all --orgs DEFAULT_TARGET_ORG --method tools/list
```

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

```shell
MCP_SERVER_REQUEST_TIMEOUT=120000 mcp-inspector --cli node --inspect-brk bin/run.js -o DEFAULT_TARGET_ORG --no-telemetry --method tools/call \
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 \
--tool-name run_soql_query \
--tool-arg directory="/path/to/sfdx-project" \
--tool-arg query="select name from Property__c order by name asc" \
Expand Down
1 change: 0 additions & 1 deletion packages/mcp/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
"format": "wireit",
"link-check": "wireit",
"lint": "wireit",
"start": "yarn build && npm link && mcp-inspector sf-mcp-server",
Copy link
Collaborator Author

@iowillhoit iowillhoit Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has had multiple issues in the past. We will instruct users to just use the mcp-inspector commands directly

"test": "wireit",
"test:only": "wireit"
},
Expand Down