Skip to content

Commit 7eb1cbb

Browse files
committed
added example usage
1 parent 6d18e27 commit 7eb1cbb

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,17 @@
22

33
The Vapi [Model Context Protocol](https://modelcontextprotocol.com/) server allows you to integrate with Vapi APIs through function calling.
44

5-
## Usage with Claude Desktop
5+
## Claude Desktop Setup
66

7-
Add the following to your `claude_desktop_config.json`. See [here](https://modelcontextprotocol.io/quickstart/user) for more details.
7+
1. Open `Claude Desktop` and press `CMD + ,` to go to `Settings`.
8+
2. Click on the `Developer` tab.
9+
3. Click on the `Edit Config` button.
10+
4. This will open the `claude_desktop_config.json` file in your file explorer.
11+
5. Get your Vapi API key from the Vapi dashboard (<https://dashboard.vapi.ai/org/api-keys>).
12+
6. Add the following to your `claude_desktop_config.json` file. See [here](https://modelcontextprotocol.io/quickstart/user) for more details.
13+
7. Restart the Claude Desktop after editing the config file.
814

915
```json
10-
1116
{
1217
"mcpServers": {
1318
"vapi-mcp-server": {
@@ -25,13 +30,24 @@ Add the following to your `claude_desktop_config.json`. See [here](https://model
2530

2631
```
2732

33+
### Example Usage with Claude Desktop
34+
35+
1. Create or import a phone number using the Vapi dashboard (<https://dashboard.vapi.ai/phone-numbers>).
36+
2. Create a new assistant using the existing 'Appointment Scheduler' template in the Vapi dashboard (<https://dashboard.vapi.ai/assistants>).
37+
3. Make sure to configure Claude Desktop to use the Vapi MCP server and restart the Claude Desktop app.
38+
4. Ask Claude with the following message:
39+
40+
```md
41+
I wanna schedule an appointment, can you connect me with Riley assistant using my phone number +1234567890?
42+
```
43+
2844
## Remote SSE Connection
2945

3046
To connect to Vapi's MCP server via Server-Sent Events (SSE) Transport:
3147

32-
- Connect to `https://mcp.vapi.ai/sse` from any MCP client using SSE Transport.
33-
- Include your Vapi API key as a bearer token in the request headers.
34-
- Example header: `Authorization: Bearer your_vapi_api_key_here`.
48+
- Connect to `https://mcp.vapi.ai/sse` from any MCP client using SSE Transport
49+
- Include your Vapi API key as a bearer token in the request headers
50+
- Example header: `Authorization: Bearer your_vapi_api_key_here`
3551

3652
This connection allows you to access Vapi's functionality remotely without running a local server.
3753

0 commit comments

Comments
 (0)