You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 44c36e1
Browse filesBrowse the repository at this point in the historyBrowse files
authored and
Chris Garber
committed
docs: lead the MCP server page with the hosted connection
Make connecting to the hosted Streamable HTTP server the primary path and
running the server locally the secondary one. Fold the duplicate
"Integration Options" and custom-client sections into "Run the server
locally" and "Use the server from your own code", mention the deprecated
SSE endpoint only in the migration note, and list docs search among the
core tools. Reword the CLI overview bullet to "Turn your agent into a Vapi
expert".
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
subtitle: Connect Vapi to AI assistants with Model Context Protocol (MCP)
3
+
subtitle: Connect your coding agent to Vapi with Model Context Protocol (MCP)
4
4
slug: sdk/mcp-server
5
-
description: Use the Vapi MCP Server to expose Vapi APIs as tools over the Model Context Protocol, managing assistants, phone numbers, and calls from any MCP client.
5
+
description: Connect Codex, Claude Code, Cursor, VS Code, or Claude Desktop to the hosted Vapi MCP server to search Vapi documentation and manage assistants, phone numbers, and calls.
6
6
---
7
7
8
8
## Overview
9
9
10
-
The **Vapi MCP Server**exposes Vapi APIs as tools via the Model Context Protocol (MCP), so you can manage assistants, phone numbers, and calls from any MCP-compatible AI assistant (like Claude Desktop) or agent framework.
10
+
The **Vapi MCP Server**gives AI agents Vapi tools over the Model Context Protocol (MCP). Once connected, your agent can search Vapi's documentation and manage your assistants, phone numbers, and calls.
11
11
12
-
Use this server to connect your AI workflows to real-world telephony, automate voice tasks, and build richer conversational agents.
12
+
Vapi hosts the server at `https://mcp.vapi.ai/mcp`, using the **Streamable HTTP** transport. Add it in your agent's MCP settings; you don't need the Vapi CLI. You can also [run the server locally](#run-the-server-locally).
13
13
14
14
<Note>
15
-
Looking to use MCP tools *inside* a Vapi assistant? See the [MCP Tool documentation](/tools/mcp) for integrating *external* MCP servers with your Vapi agents.
15
+
Looking to use MCP tools *inside* a Vapi assistant? See [MCP tools](/tools/mcp).
16
16
</Note>
17
17
18
-
<Tip>
19
-
Connect your coding agent directly to the hosted MCP server using its native MCP settings. The Vapi CLI is not required. For public agent skills and installation instructions, see [VapiAI/skills](https://github.com/VapiAI/skills).
20
-
</Tip>
21
-
22
-
<Note>
23
-
If an earlier CLI release configured `@vapi-ai/mcp-docs-server` in your agent, replace that legacy entry with the hosted connection below. Existing agent configurations are not removed automatically.
24
-
</Note>
25
-
26
-
Use **Streamable HTTP** at `https://mcp.vapi.ai/mcp` for remote connections. The legacy HTTP+SSE transport is deprecated; migrate existing remote configurations to this endpoint.
27
-
28
18
## Connect your agent
29
19
30
-
Get a [Vapi API key](/security-and-privacy/api-keys), then choose your client. These connections use the hosted server; you do not need to install the Vapi CLI or run a Vapi MCP server locally.
20
+
Get a [Vapi API key](/security-and-privacy/api-keys), then choose your agent.
31
21
32
22
<Tabs>
33
23
<Tabtitle="Codex">
@@ -121,12 +111,12 @@ Get a [Vapi API key](/security-and-privacy/api-keys), then choose your client. T
121
111
}
122
112
```
123
113
124
-
Start `vapi` from **MCP: List Servers** and enter your API key when prompted. Use a **Local** chat session and enable its tools. VS Code does not forward servers that use input prompts to Copilot harness sessions.
114
+
Start `vapi` from **MCP: List Servers** and enter your API key when prompted. Then use a **Local** chat session and enable the server's tools. Other session types can't prompt for the key, so this server isn't available in them.
125
115
126
116
See [VS Code MCP setup](https://code.visualstudio.com/docs/agents/reference/mcp-configuration).
127
117
</Tab>
128
118
<Tabtitle="Claude Desktop">
129
-
To connect through Claude Desktop's local stdio configuration, use `mcp-remote` as a bridge to the hosted server. This option requires Node.js and `npx` to be available to Claude Desktop.
119
+
Claude Desktop's configuration file runs local commands, so use `mcp-remote` as a bridge to the hosted server. This requires Node.js and `npx` to be available to Claude Desktop.
130
120
131
121
Open **Settings → Developer → Edit Config**. Add this entry to `claude_desktop_config.json`, preserving any other servers:
132
122
@@ -152,20 +142,49 @@ Get a [Vapi API key](/security-and-privacy/api-keys), then choose your client. T
152
142
}
153
143
```
154
144
155
-
Replace `YOUR_VAPI_API_KEY` with your Vapi API key and restart Claude Desktop. Keep this configuration private and update the key after rotating it. This starts a local adapter; Vapi's MCP server stays hosted.
145
+
Replace `YOUR_VAPI_API_KEY` with your Vapi API key and restart Claude Desktop. Keep this configuration private and update the key after rotating it. The bridge runs locally; Vapi's MCP server stays hosted.
156
146
</Tab>
157
147
</Tabs>
158
148
159
149
Once connected, try asking your agent: "List my Vapi assistants."
160
150
161
-
---
151
+
<Note>
152
+
**Replacing an older setup?** If your agent uses `@vapi-ai/mcp-docs-server` from an earlier CLI release, or the deprecated `https://mcp.vapi.ai/sse` endpoint, replace that entry with the hosted connection above. The hosted server includes documentation search. Existing agent configurations are not changed automatically.
153
+
</Note>
162
154
163
-
## Core Tools
155
+
## Run the server locally
164
156
165
-
The Vapi MCP Server exposes these actions as MCP tools:
157
+
You can run the open-source [Vapi MCP server](https://github.com/VapiAI/mcp-server) on your own machine instead of connecting to the hosted one, for example to develop against it. This requires Node.js. Your client starts the server as a subprocess and talks to it over stdio, so no HTTP endpoint is started.
158
+
159
+
Add this entry to your client's MCP configuration in place of the hosted connection. The local server reads your API key from `VAPI_TOKEN`:
160
+
161
+
```json
162
+
{
163
+
"mcpServers": {
164
+
"vapi": {
165
+
"command": "npx",
166
+
"args": ["-y", "@vapi-ai/mcp-server"],
167
+
"env": {
168
+
"VAPI_TOKEN": "YOUR_VAPI_API_KEY"
169
+
}
170
+
}
171
+
}
172
+
}
173
+
```
166
174
167
-
| Tool | Description | Example Usage |
175
+
In Claude Code, run:
176
+
177
+
```bash
178
+
claude mcp add -e VAPI_TOKEN=YOUR_VAPI_API_KEY vapi -- npx -y @vapi-ai/mcp-server
|`ask_vapi_docs`| Search Vapi documentation | Ask how a Vapi feature works |
169
188
|`list_assistants`| List all Vapi assistants | Show all configured assistants |
170
189
|`create_assistant`| Create a new Vapi assistant | Add a new assistant for a use case |
171
190
|`get_assistant`| Get a Vapi assistant by ID | View assistant config |
@@ -177,136 +196,61 @@ The Vapi MCP Server exposes these actions as MCP tools:
177
196
|`list_tools`| List all available Vapi tools | Tool discovery |
178
197
|`get_tool`| Get details of a specific tool | Tool integration info |
179
198
180
-
<Note>
181
-
<b>Scheduling calls:</b> The <code>create_call</code> action supports scheduling with the optional <code>scheduledAt</code> parameter.
182
-
</Note>
199
+
To schedule a call, pass the optional `scheduledAt` parameter to `create_call`. `create_call` places a real phone call.
183
200
184
-
---
201
+
## Use the server from your own code
185
202
186
-
## Integration Options
203
+
Connect any MCP client to `https://mcp.vapi.ai/mcp` over Streamable HTTP, and send your Vapi API key in the `Authorization: Bearer YOUR_VAPI_API_KEY` header.
187
204
188
-
<Tabs>
189
-
<Tabtitle="Remote (Streamable HTTP)">
190
-
Connect to the Vapi-hosted MCP server using the Streamable HTTP protocol.
191
-
<Note>
192
-
Recommended for most production use cases.
193
-
</Note>
194
-
<Warning>
195
-
Use this for clients or SDKs that support Streamable HTTP transport.
196
-
</Warning>
197
-
198
-
- **Endpoint:**`https://mcp.vapi.ai/mcp`
199
-
- **Authentication:** Pass your Vapi API key as a bearer token:
Configure the URL and authentication header directly in clients with remote MCP support. For a client that needs a local stdio adapter, use the [Claude Desktop tab](#connect-your-agent) above.
203
-
</Tab>
204
-
<Tabtitle="OpenAI responses API">
205
-
<Note>
206
-
The OpenAI <code>responses</code> API now supports MCP. <ahref="https://platform.openai.com/docs/guides/tools-remote-mcp#page-top"target="_blank"rel="noopener">Read more here</a>.
207
-
</Note>
208
-
<CodeBlocks>
209
-
```typescript title="typescript"
210
-
import OpenAI from 'openai';
211
-
// Replace with your actual OpenAI API key
212
-
const openai = new OpenAI({apiKey: 'YOUR_OPENAI_API_KEY'});
Set up your SDK to connect to <code>https://mcp.vapi.ai/mcp</code> using **Streamable HTTP** and authenticate with your Vapi API key in the <code>Authorization: Bearer YOUR_VAPI_API_KEY</code> header.
301
-
</Step>
302
-
<Steptitle="Use MCP tools">
303
-
Query available tools, list assistants, create calls, etc, via your SDK.
Official MCP SDKs are available for [TypeScript](https://github.com/modelcontextprotocol/typescript-sdk), [Python](https://github.com/modelcontextprotocol/python-sdk), [Java](https://github.com/modelcontextprotocol/java-sdk), [Kotlin](https://github.com/modelcontextprotocol/kotlin-sdk), and [C#](https://github.com/modelcontextprotocol/csharp-sdk). This minimal Node.js client lists your assistants:
<Note> For more detailed examples and complete client implementations, see the [MCP Client Quickstart](https://modelcontextprotocol.io/quickstart/client). </Note>
0 commit comments