Skip to content

Commit 6d18e27

Browse files
committed
Updated docs
1 parent 6df4320 commit 6d18e27

1 file changed

Lines changed: 39 additions & 20 deletions

File tree

README.md

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,11 @@
22

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

5-
## Setup
6-
7-
To run the Vapi MCP server using npx, use the following command:
8-
9-
```bash
10-
# To set up all available tools
11-
export VAPI_TOKEN=your_vapi_token
12-
13-
npx -y @vapi-ai/mcp-server
14-
```
15-
16-
### Usage with Claude Desktop
5+
## Usage with Claude Desktop
176

187
Add the following to your `claude_desktop_config.json`. See [here](https://modelcontextprotocol.io/quickstart/user) for more details.
198

20-
```
9+
```json
2110

2211
{
2312
"mcpServers": {
@@ -36,6 +25,16 @@ Add the following to your `claude_desktop_config.json`. See [here](https://model
3625

3726
```
3827

28+
## Remote SSE Connection
29+
30+
To connect to Vapi's MCP server via Server-Sent Events (SSE) Transport:
31+
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`.
35+
36+
This connection allows you to access Vapi's functionality remotely without running a local server.
37+
3938
## Development
4039

4140
```bash
@@ -46,16 +45,29 @@ npm install
4645
npm run build
4746
```
4847

49-
```bash
50-
# Run the server in development mode with hot reloading
51-
npm run dev
48+
Update your `claude_desktop_config.json` to use the local server.
49+
50+
```json
51+
{
52+
"mcpServers": {
53+
"vapi-local": {
54+
"command": "node",
55+
"args": [
56+
"<path_to_vapi_mcp_server>/dist/index.js"
57+
],
58+
"env": {
59+
"VAPI_TOKEN": "<your_vapi_token>"
60+
}
61+
},
62+
}
63+
}
5264
```
5365

54-
## Testing
66+
### Testing
5567

5668
The project has two types of tests:
5769

58-
### Unit Tests
70+
#### Unit Tests
5971

6072
Unit tests use mocks to test the MCP server without making actual API calls to Vapi.
6173

@@ -64,7 +76,7 @@ Unit tests use mocks to test the MCP server without making actual API calls to V
6476
npm run test:unit
6577
```
6678

67-
### End-to-End Tests
79+
#### End-to-End Tests
6880

6981
E2E tests run the full MCP server with actual API calls to Vapi.
7082

@@ -78,10 +90,17 @@ npm run test:e2e
7890

7991
Note: E2E tests require a valid Vapi API token to be set in the environment.
8092

81-
## Running All Tests
93+
#### Running All Tests
8294

8395
To run all tests at once:
8496

8597
```bash
8698
npm test
8799
```
100+
101+
## References
102+
103+
- [VAPI Remote MCP Server](https://mcp.vapi.ai/)
104+
- [VAPI MCP Tool](https://docs.vapi.ai/tools/mcp)
105+
- [Model Context Protocol](https://modelcontextprotocol.com/)
106+
- [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)

0 commit comments

Comments
 (0)