docs: correct MCP setup to match the shipped CLI and server - #1238
Draft
chris-garber-vapi wants to merge 1 commit into
Draft
chris-garber-vapi wants to merge 1 commit into
chris-garber-vapi wants to merge 1 commit into
Conversation
Both MCP pages documented a different package, different config paths, and different JSON shapes than the tools actually use. fern/cli/mcp-integration.mdx `vapi mcp setup` configures @vapi-ai/mcp-docs-server (documentation lookup), not @vapi-ai/mcp-server (the action server). Verified at VapiAI/cli cmd/mcp.go:293 and :352-355. Corrections against that source: - Package name throughout. - Config paths. The page claimed project-local `.cursor/mcp.json` and `.windsurf/mcp.json`, and "workspace settings" for VS Code. The CLI writes ~/.cursor/mcp.json, ~/.codeium/windsurf/mcp_config.json, and ~/.vscode/mcp.json. Because these are in $HOME the integration is global, so the advice to run setup per project and commit the files to your repo was wrong in both directions. - JSON shape. Cursor and Windsurf use the `mcpServers` key, not `servers`. VS Code uses `servers` plus `"type": "stdio"`. The server entry is named `vapi`, not `vapi-docs`, and args include `-y`. - Removed `vapi mcp remove`. No such subcommand exists; only `setup` and `status` are registered. - Removed the global install/update instructions. The command runs through `npx -y`, so there is nothing installed globally to update, and `npm list -g` will never show it. - Removed fabricated `vapi mcp status` output, including a version line the command does not print. - Removed "eliminating AI hallucinations" and "API hallucinations are eliminated", and the invented IDE-generated code samples presented as what the assistant will produce. - Added a note distinguishing this documentation server from the action server. fern/sdk/mcp-server.mdx - The `vapi mcp setup` tip sent readers to a different server. Replaced with a note explaining the distinction. - Removed "connect to the local server endpoint (default: http://localhost:3000)". @vapi-ai/mcp-server communicates over stdio. - Marked the SSE transport and tabs deprecated in favor of streamable HTTP. - Tool catalog listed 10 tools; the server registers 13. Added update_assistant, create_tool, and update_tool, and noted that list_assistants returns at most 10 results. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Lightsage docs evalsResult: passed Average score: 100/100
|
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a0b355-48bb-73fc-926a-c27ff4f2ee8d.docs.buildwithfern.com |
chris-garber-vapi
marked this pull request as draft
September 18, 2026 20:37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Both MCP pages document a different package, different config paths, and different JSON shapes than the tools actually use. Someone following docs.vapi.ai/cli/mcp today edits files that aren't the ones the CLI writes.
vapi mcp setupconfigures@vapi-ai/mcp-docs-server— documentation lookup, no API key — not@vapi-ai/mcp-server, the action server. Verified atcmd/mcp.go:293.fern/cli/mcp-integration.mdxCorrections, each checked against
cmd/mcp.go:@vapi-ai/mcp-server@vapi-ai/mcp-docs-server.cursor/mcp.json(project)~/.cursor/mcp.json.windsurf/mcp.json~/.codeium/windsurf/mcp_config.jsongithub.copilot.advanced~/.vscode/mcp.json"servers"key for Cursor/Windsurf"mcpServers"vapi-docsvapiargs: ["@vapi-ai/mcp-server"]args: ["-y", "@vapi-ai/mcp-docs-server"]Because those paths are in
$HOME, the integration is global — so the page's advice to run setup per project and to commit the config files to your repo was wrong in both directions. Both sections removed.Also removed, as things that don't exist or don't happen:
vapi mcp remove. No such subcommand. Onlysetupandstatusare registered (mcp.go:76,:95). Replaced with instructions to edit the entry out by hand, plus a warning not to delete the whole file since it holds your other MCP servers.npm update -g/npm install -g/npm list -g. The command runs vianpx -y, so nothing is installed globally andnpm list -gwill never show it.vapi mcp statusoutput, including aVapi MCP Server: v1.2.3 (latest)line the command doesn't print.systemPromptfield Vapi doesn't have.Added a note at the top distinguishing this documentation server from the action server, since the two pages previously read as if they covered the same thing.
fern/sdk/mcp-server.mdxvapi mcp setuptip sent readers to a different server entirely. Replaced with a note explaining the distinction.http://localhost:3000)" —@vapi-ai/mcp-servercommunicates over stdio (src/index.ts). There is no port to connect to.update_assistant,create_tool, andupdate_tool, enumerated fromsrc/tools/*.ts. Also noted thatlist_assistantsreturns at most 10 results — it's hardcoded to{ limit: 10 }but was documented as "List all Vapi assistants."Verification
getCursorDir/getWindsurfDir/getVSCodeDir(mcp.go:391-415).CursorMCPConfig/VSCodeMCPConfigstruct tags (mcp.go:37-54).registerTool(/server.tool(call sites in the mcp-server repo.fern checknot run locally —FERN_CLI_PATHis unset and the Fern CLI isn't installed here. MDX body content only, nodocs.ymlor API spec changes.Not execution-tested: the CLI was read, not run. Worth someone running
vapi mcp setuponce against the released binary to confirm the paths before merge.🤖 Generated with Claude Code