Repository navigation
docs: list every Vapi MCP tool and add docs-only access - #1410
Conversation
44c36e1 to
83358b9
Compare
|
🌿 Preview your docs: https://vapi-preview-01a1c3ae-3a3e-72bc-9e06-c4d809284b53.docs.buildwithfern.com |
|
🌿 Preview your docs: https://vapi-preview-01a1c3ae-b987-7562-ab1a-b5ebd3232c31.docs.buildwithfern.com |
|
🌿 Preview your docs: https://vapi-preview-01a1c3b0-802e-715d-8fd6-d3b8b4ff4e26.docs.buildwithfern.com |
Dropping this example in the OAuth rewrite left the page with no Python or TypeScript sample, which #1410 had. Restoring it keeps that coverage. The old example passed `headers: {"Authorization": "Bearer <api key>"}`. That was wrong twice over: the Responses API takes an `authorization` field and has no `headers` field, and the hosted server no longer takes API keys. The restored example uses `authorization` with an access token from the sign-in flow, and notes that the token is short-lived and that the API asks for approval unless `require_approval` is set. Also updates the OpenAI docs link, which now redirects to developers.openai.com/api/docs/guides/tools-connectors-mcp. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
🌿 Preview your docs: https://vapi-preview-01a1c6ef-14b8-72ad-ad78-cbcd5fdf02f7.docs.buildwithfern.com |
| | `get_simulation_run` | Get a run with its status, item counts, and item summaries | | ||
| | `get_simulation_run_item` | Get one run item in full, including results, call snapshots, and transcript | | ||
|
|
||
| `run_simulations` places real calls against the assistant you point it at. |
There was a problem hiding this comment.
run_simulations doesn't dial a phone number; simulations run over Vapi's web chat or WebSocket transport. Each run is billed, though, so the note should be about cost rather than real calls.
| `run_simulations` places real calls against the assistant you point it at. | |
| <Info> | |
| Each `run_simulations` tool call starts a billed simulation run. For more information, see [Simulations overview](/observability/simulations-overview). | |
| </Info> |
There was a problem hiding this comment.
Applied — you're right that run_simulations doesn't dial a number, and my line was wrong. One flag: "billed" isn't stated anywhere else in the docs. The closest is the simulations overview saying chat mode "costs less because it skips speech synthesis and transcription". If per-run billing isn't something we want to assert here, say so and I'll drop that clause and keep just the pointer to the overview.
Address stephenvapiai's review on #1410: - Name every agent tab plus tools and simulations in the page description, which feeds llms.txt. - Lowercase "server" in the title and body to match the nav label and the rest of the docs. - Trim the "Replacing an older setup?" callout to two sentences and lead with why the reader needs to act. - Rename "Core tools" to "Available tools", since the section now lists every tool. - Use the simulations docs' own term, "AI tester", in place of "scripted callers", "simulated callers", and "testers". - Correct the run_simulations note: simulations don't place phone calls, but each run is billed. - Move the create_call real-call warning into its own Info callout. - Avoid starting sentences with code identifiers. - Say "coding agent" in the CLI overview, since "agent" alone reads as a voice agent elsewhere in the docs. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
🌿 Preview your docs: https://vapi-preview-01a1c780-2401-7296-8de3-9e32b41f2601.docs.buildwithfern.com |
Dropping this example in the OAuth rewrite left the page with no Python or TypeScript sample, which #1410 had. Restoring it keeps that coverage. The old example passed `headers: {"Authorization": "Bearer <api key>"}`. That was wrong twice over: the Responses API takes an `authorization` field and has no `headers` field, and the hosted server no longer takes API keys. The restored example uses `authorization` with an access token from the sign-in flow, and notes that the token is short-lived and that the API asks for approval unless `require_approval` is set. Also updates the OpenAI docs link, which now redirects to developers.openai.com/api/docs/guides/tools-connectors-mcp. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The hosted MCP page from #1417 still listed 10 of the server's tools and omitted ask_vapi_docs. The hosted server pins @vapi-ai/mcp-server 0.1.0 and registers all 29 of its tools, plus the hosted-only get_connection_info. - Replace the Core Tools table with the full list, grouped by area: connection, documentation and reference, assistants, calls, phone numbers, Vapi tools, and simulations. Descriptions come from each tool's registered description. - Add notes that create_call places a real phone call, that each run_simulations call starts a billed simulation run, and that load_skill does not install anything or run scripts. - Add "Search the docs without signing in" for the keyless documentation server at docs.vapi.ai/_mcp/server, and link to it from the legacy mcp-docs-server note. - Point the organization FAQ at get_connection_info. - Lowercase "server" in the title and body, as in the nav and the rest of the docs. Say "coding agent" in the CLI overview. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
f487fe9 to
67ca955
Compare
|
🌿 Preview your docs: https://vapi-preview-01a1cbf2-43f8-7227-b78f-b74d2001d953.docs.buildwithfern.com |
Completes the hosted MCP page after the OAuth rewrite in #1417: lists every tool the server exposes, and adds keyless documentation access.
Rebased onto
main. #1417 replaced the page's connection and sign-in content with tested OAuth instructions, so this PR keeps all of that as is and adds only what #1417 didn't cover. It also absorbs the remaining piece of #1411 (closed as superseded by #1417).What changed
Tool list. The page listed 10 tools and omitted
ask_vapi_docs. The hosted server pins@vapi-ai/mcp-server0.1.0 (still the latest on npm) and registers all 29 of its tools, plus the hosted-onlyget_connection_info. The table is now grouped by area, using each tool's registered description. Three short notes call out side effects:create_callplaces a real call, eachrun_simulationscall starts a billed run, andload_skillinstalls nothing.Docs-only access. New "Search the docs without signing in" section for
https://docs.vapi.ai/_mcp/server, which needs no account. The legacy@vapi-ai/mcp-docs-servernote now links to it as the like-for-like replacement.Small fixes. The organization FAQ points to
get_connection_info. "Vapi MCP server" is lowercased to match the nav and the rest of the docs. The CLI overview says "coding agent".Verification
fern checkis clean, andfern docs broken-linksreports only the pre-existing/config-as-code.mdlink inquickstart/introduction.mdx. In-page anchors checked by hand, since neither command validates them.🤖 Generated with Claude Code