@vapi-ai/mcp-server 0.0.8 → 0.0.10

package/README.md

@@ -2,33 +2,32 @@
 
 [![smithery badge](https://smithery.ai/badge/@VapiAI/vapi-mcp-server)](https://smithery.ai/server/@VapiAI/vapi-mcp-server)
 
-The Vapi [Model Context Protocol](https://modelcontextprotocol.com/) server allows you to integrate with Vapi APIs through function calling.
+Build AI voice assistants and phone agents with [Vapi](https://vapi.ai) using the [Model Context Protocol](https://modelcontextprotocol.com/).
 
 <a href="https://glama.ai/mcp/servers/@VapiAI/mcp-server">
   <img width="380" height="200" src="https://glama.ai/mcp/servers/@VapiAI/mcp-server/badge" alt="Vapi Server MCP server" />
 </a>
 
-## Claude Desktop Setup
+## Setup
 
-1. Open `Claude Desktop` and press `CMD + ,` to go to `Settings`.
-2. Click on the `Developer` tab.
-3. Click on the `Edit Config` button.
-4. This will open the `claude_desktop_config.json` file in your file explorer.
-5. Get your Vapi API key from the Vapi dashboard (<https://dashboard.vapi.ai/org/api-keys>).
-6. Add the following to your `claude_desktop_config.json` file. See [here](https://modelcontextprotocol.io/quickstart/user) for more details.
-7. Restart the Claude Desktop after editing the config file.
+The MCP server requires a Vapi API key. Get one from the [Vapi dashboard](https://dashboard.vapi.ai/org/api-keys).
 
-### Local Configuration
+### Local Server (stdio)
+
+Configure any MCP client that supports local stdio servers to run:
+
+```text
+npx -y @vapi-ai/mcp-server
+```
+
+Set `VAPI_TOKEN` in the server environment. MCP client configuration formats vary, but the server definition generally looks like this:
 
 ```json
 {
   "mcpServers": {
-    "vapi-mcp-server": {
+    "vapi": {
       "command": "npx",
-      "args": [
-          "-y",
-          "@vapi-ai/mcp-server"
-      ],
+      "args": ["-y", "@vapi-ai/mcp-server"],
       "env": {
         "VAPI_TOKEN": "<your_vapi_token>"
       }
@@ -37,12 +36,29 @@ The Vapi [Model Context Protocol](https://modelcontextprotocol.com/) server allo
 }
 ```
 
-### Remote Configuration
+### Remote Server (Streamable HTTP)
+
+Clients that support remote MCP servers can connect directly:
+
+- URL: `https://mcp.vapi.ai/mcp`
+- Header: `Authorization: Bearer your_vapi_api_key_here`
+
+### Client-Specific Examples
+
+#### Claude Code
+
+```bash
+claude mcp add -e VAPI_TOKEN=your_vapi_token vapi -- npx -y @vapi-ai/mcp-server
+```
+
+#### Claude Desktop
+
+Use the local server configuration above in the Claude Desktop configuration file. To connect to the hosted server through an stdio bridge instead:
 
 ```json
 {
   "mcpServers": {
-    "vapi-mcp": {
+    "vapi": {
       "command": "npx",
       "args": [
         "mcp-remote",
@@ -58,40 +74,50 @@ The Vapi [Model Context Protocol](https://modelcontextprotocol.com/) server allo
 }
 ```
 
-### Example Usage with Claude Desktop
+### Optional Agent Skill
 
-1. Create or import a phone number using the Vapi dashboard (<https://dashboard.vapi.ai/phone-numbers>).
-2. Create a new assistant using the existing 'Appointment Scheduler' template in the Vapi dashboard (<https://dashboard.vapi.ai/assistants>).
-3. Make sure to configure Claude Desktop to use the Vapi MCP server and restart the Claude Desktop app.
-4. Ask Claude to initiate or schedule a call. See examples below:
+The [`skill`](./skill) directory contains reusable instructions for AI coding agents that support Agent Skills. Install it using your host's skill installation process.
 
-**Example 1:** Request an immediate call
+For Claude Code:
 
-```md
-I'd like to speak with my ShopHelper assistant to talk about my recent order. Can you have it call me at +1234567890?
+```bash
+mkdir -p ~/.claude/skills/vapi
+curl -o ~/.claude/skills/vapi/SKILL.md https://raw.githubusercontent.com/VapiAI/mcp-server/main/skill/SKILL.md
 ```
 
-**Example 2:** Schedule a future call
+---
+
+## Example Usage
 
-```md
-I need to schedule a call with Mary assistant for next Tuesday at 3:00 PM. My phone number is +1555123456.
+### Create a Voice Assistant
+
+Ask your MCP-enabled agent:
+```
+I want to build a voice assistant that can schedule appointments
 ```
 
-**Example 3:** Make a call with dynamic variables
+### Make an Outbound Call
 
-```md
-I want to call +1234567890 with my appointment reminder assistant. Use these details:
+```
+Call +1234567890 using my appointment reminder assistant with these details:
 - Customer name: Sarah Johnson
 - Appointment date: March 25th
 - Appointment time: 2:30 PM
-- Doctor name: Dr. Smith
 ```
 
+### Schedule a Future Call
+
+```
+Schedule a call with my support assistant for next Tuesday at 3:00 PM to +1555123456
+```
+
+---
+
 ## Using Variable Values in Assistant Prompts
 
-The `create_call` action supports passing dynamic variables through `assistantOverrides.variableValues`. These variables can be used in your assistant's prompts using double curly braces: `{{variableName}}`.
+The `create_call` action supports passing dynamic variables through `assistantOverrides.variableValues`. Use double curly braces in your assistant's prompts: `{{variableName}}`.
 
-### Example Assistant Prompt with Variables
+### Example Prompt with Variables
 
 ```
 Hello {{customerName}}, this is a reminder about your appointment on {{appointmentDate}} at {{appointmentTime}} with {{doctorName}}.
@@ -99,7 +125,7 @@ Hello {{customerName}}, this is a reminder about your appointment on {{appointme
 
 ### Default Variables
 
-The following variables are automatically available (no need to pass in variableValues):
+These are automatically available (no need to pass):
 
 - `{{now}}` - Current date and time (UTC)
 - `{{date}}` - Current date (UTC)
@@ -109,29 +135,58 @@ The following variables are automatically available (no need to pass in variable
 - `{{year}}` - Current year (UTC)
 - `{{customer.number}}` - Customer's phone number
 
-For more details on default variables and advanced date/time formatting, see the [official Vapi documentation](https://docs.vapi.ai/assistants/dynamic-variables#default-variables).
+See [Vapi documentation](https://docs.vapi.ai/assistants/dynamic-variables#default-variables) for advanced date/time formatting.
 
-## Remote MCP
+---
 
-To connect to Vapi's MCP server remotely:
+## Remote MCP Server
 
-### Streamable HTTP (Recommended)
+Connect to Vapi's hosted MCP server from any MCP client:
 
-The default and recommended way to connect is via Streamable HTTP Transport:
+### Streamable HTTP (Recommended)
 
-- Connect to `https://mcp.vapi.ai/mcp` from any MCP client using Streamable HTTP Transport
-- Include your Vapi API key as a bearer token in the request headers
-- Example header: `Authorization: Bearer your_vapi_api_key_here`
+- URL: `https://mcp.vapi.ai/mcp`
+- Header: `Authorization: Bearer your_vapi_api_key_here`
 
 ### SSE (Deprecated)
 
-Server-Sent Events (SSE) Transport is still supported but deprecated:
+- URL: `https://mcp.vapi.ai/sse`
+- Header: `Authorization: Bearer your_vapi_api_key_here`
+
+---
+
+## Available Tools
+
+### Assistants
+| Tool | Description |
+|------|-------------|
+| `list_assistants` | List all assistants |
+| `get_assistant` | Get assistant by ID |
+| `create_assistant` | Create new assistant |
+| `update_assistant` | Update assistant |
 
-- Connect to `https://mcp.vapi.ai/sse` from any MCP client using SSE Transport
-- Include your Vapi API key as a bearer token in the request headers
-- Example header: `Authorization: Bearer your_vapi_api_key_here`
+### Calls
+| Tool | Description |
+|------|-------------|
+| `list_calls` | List call history |
+| `get_call` | Get call details |
+| `create_call` | Start outbound call (immediate or scheduled) |
 
-This connection allows you to access Vapi's functionality remotely without running a local server.
+### Phone Numbers
+| Tool | Description |
+|------|-------------|
+| `list_phone_numbers` | List phone numbers |
+| `get_phone_number` | Get phone number details |
+
+### Tools (Function Calling)
+| Tool | Description |
+|------|-------------|
+| `list_tools` | List custom tools |
+| `get_tool` | Get tool details |
+| `create_tool` | Create tool for API integration |
+| `update_tool` | Update tool |
+
+---
 
 ## Development
 
@@ -139,101 +194,64 @@ This connection allows you to access Vapi's functionality remotely without runni
 # Install dependencies
 npm install
 
-# Build the server
+# Build
 npm run build
 
-# Use inspector to test the server
+# Test with MCP inspector
 npm run inspector
 ```
 
-Update your `claude_desktop_config.json` to use the local server.
+### Local Development Config
 
 ```json
 {
   "mcpServers": {
     "vapi-local": {
       "command": "node",
-      "args": [
-        "<path_to_vapi_mcp_server>/dist/index.js"
-      ],
+      "args": ["<path>/dist/index.js"],
       "env": {
         "VAPI_TOKEN": "<your_vapi_token>"
       }
-    },
+    }
   }
 }
 ```
 
 ### Testing
 
-The project has two types of tests:
+```bash
+# Safe default suite (build, mocked execution, contract, and stdio compatibility)
+npm test
 
-#### Unit Tests
+# Unit tests (mocked public tool execution and catalog contract)
+npm run test:unit
 
-Unit tests use mocks to test the MCP server without making actual API calls to Vapi.
+# Documentation/tool-catalog consistency lint
+npm run test:docs
 
-```bash
-# Run unit tests
-npm run test:unit
-```
+# Full TypeScript check (production and test code)
+npm run typecheck
 
-#### End-to-End Tests
+# Build and run local stdio protocol compatibility tests (no Vapi API calls)
+npm run test:stdio
 
-E2E tests run the full MCP server with actual API calls to Vapi.
+# Pack, install, and launch the package from a clean temporary consumer
+npm run test:package
 
-```bash
-# Set your Vapi API token
+# Live read-only API tests
 export VAPI_TOKEN=your_token_here
+npm run test:live:readonly
 
-# Run E2E tests
-npm run test:e2e
+# Live mutating tests (creates and cleans up disposable assistants and tools)
+export VAPI_TOKEN=your_test_org_token_here
+npm run test:live:mutating
 ```
 
-Note: E2E tests require a valid Vapi API token to be set in the environment.
-
-#### Running All Tests
-
-To run all tests at once:
-
-```bash
-npm test
-```
+---
 
 ## References
 
-- [VAPI Remote MCP Server](https://mcp.vapi.ai/)
-- [VAPI MCP Tool](https://docs.vapi.ai/tools/mcp)
-- [VAPI MCP Server SDK](https://docs.vapi.ai/sdk/mcp-server)
+- [Vapi Documentation](https://docs.vapi.ai)
+- [Vapi Dashboard](https://dashboard.vapi.ai)
+- [Vapi Remote MCP Server](https://mcp.vapi.ai/)
 - [Model Context Protocol](https://modelcontextprotocol.com/)
-- [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)
-
-## Supported Actions
-
-The Vapi MCP Server provides the following tools for integration:
-
-### Assistant Tools
-
-- `list_assistants`: Lists all Vapi assistants
-- `create_assistant`: Creates a new Vapi assistant
-- `update_assistant`: Updates an existing Vapi assistant
-- `get_assistant`: Gets a Vapi assistant by ID
-
-### Call Tools
-
-- `list_calls`: Lists all Vapi calls
-- `create_call`: Creates an outbound call with support for:
-  - Immediate or scheduled calls
-  - Dynamic variable values through `assistantOverrides`
-- `get_call`: Gets details of a specific call
-
-> **Note:** The `create_call` action supports scheduling calls for immediate execution or for a future time. You can also pass dynamic variables using `assistantOverrides.variableValues` to personalize assistant messages.
-
-### Phone Number Tools
-
-- `list_phone_numbers`: Lists all Vapi phone numbers
-- `get_phone_number`: Gets details of a specific phone number
-
-### Vapi Tools
-
-- `list_tools`: Lists all Vapi tools
-- `get_tool`: Gets details of a specific tool

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAQpE,iBAAS,eAAe,cAiBvB;AA8BD,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAYpE,iBAAS,eAAe,cAgBvB;AAgCD,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/index.js

@@ -1,10 +1,12 @@
 #!/usr/bin/env node
+import { readFileSync } from 'node:fs';
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
 import { registerAllTools } from './tools/index.js';
 import { createVapiClient } from './client.js';
 import dotenv from 'dotenv';
 dotenv.config();
+const packageMetadata = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8'));
 function createMcpServer() {
     const vapiToken = process.env.VAPI_TOKEN;
     if (!vapiToken) {
@@ -13,8 +15,7 @@ function createMcpServer() {
     const vapiClient = createVapiClient(vapiToken);
     const mcpServer = new McpServer({
         name: 'Vapi MCP',
-        version: '0.1.0',
-        capabilities: [],
+        version: packageMetadata.version,
     });
     registerAllTools(mcpServer, vapiClient);
     return mcpServer;
@@ -27,6 +28,7 @@ async function main() {
         setupShutdownHandler(mcpServer);
     }
     catch (err) {
+        console.error('Failed to start MCP server:', err);
         process.exit(1);
     }
 }
@@ -42,6 +44,7 @@ function setupShutdownHandler(mcpServer) {
     });
 }
 main().catch((err) => {
+    console.error('Fatal error:', err);
     process.exit(1);
 });
 export { createMcpServer };