README
🚀 Vapi MCP 用于 Cursor 的实现
本项目达成了将 Vapi 的语音 AI 功能与 Cursor 集成的 Model Context Protocol (MCP) 服务器,实现了两者之间的数据交互。
✨ 主要特性
- 实现 Vapi 语音 AI 功能与 Cursor 的集成。
- 提供 MCP 服务器,用于监听和处理请求。
📦 安装指南
环境配置
在 vapi-mcp-server 目录下创建一个 .env 文件,包含以下变量:
# Vapi API 密钥
VAPI_ORG_ID=your-org-id
VAPI_PRIVATE_KEY=your-private-key
VAPI_KNOWLEDGE_ID=your-knowledge-id
VAPI_JWT_PRIVATE=your-jwt-private
# 环境配置
NODE_ENV=development
服务器构建
要构建服务器,执行以下命令:
cd vapi-mcp/vapi-mcp-server
npm install
npm run build
💻 使用示例
基础用法
在 Cursor 中配置 Vapi MCP 服务器,以下是正确的 .cursor/mcp.json 配置示例:
"Vapi Voice AI Tools": {
"command": "node",
"type": "stdio",
"args": [
"/Users/matthewcage/Documents/AA-GitHub/MCP/vapi-mcp/vapi-mcp-server/dist/index.js"
],
"cwd": "/Users/matthewcage/Documents/AA-GitHub/MCP/vapi-mcp/vapi-mcp-server",
"env": {
"VAPI_ORG_ID": "your-org-id",
"VAPI_PRIVATE_KEY": "your-private-key",
"VAPI_KNOWLEDGE_ID": "your-knowledge-id",
"VAPI_JWT_PRIVATE": "your-jwt-private",
"NODE_ENV": "development"
}
}
📚 详细文档
项目结构
Vapi MCP 服务器的结构如下:
vapi-mcp-server/- 主服务器代码src/- TypeScript 源文件dist/- 编译后的 JavaScript 输出.env- 环境变量文件(用于 API 密钥)
在 Cursor 中的配置
注意:避免“客户端已关闭”错误
在 Cursor 的 MCP 设置中配置 Vapi MCP 服务器时,请注意以下重要事项:
- 工作目录:
cwd参数是必需的,以确保服务器在正确的目录下运行,并能够正确访问.env文件。 - 环境变量:即使存在
.env文件,也必须显式地将环境变量提供到配置中。 - 模块类型:由于服务器使用 ES 模块,因此
package.json中必须包含"type": "module"。
故障排除
“客户端已关闭”错误在 Cursor 中
如果在 Cursor 的 MCP 工具面板中看到“客户端已关闭”,可按以下步骤排查:
- 检查工作目录:确保
cwd参数在您的mcp.json中设置正确。 - 验证环境变量:确认所有必需的环境变量都已通过配置传递。
- 检查模块类型:确保
package.json包含"type": "module"。 - 检查权限:确保
dist/index.js文件具有可执行权限(使用chmod +x dist/index.js)。 - 直接测试服务器:尝试手动运行服务器以检查错误:
cd vapi-mcp/vapi-mcp-server
node --trace-warnings dist/index.js
模块未找到错误
如果出现“错误:找不到模块”,可按以下步骤处理:
- 检查工作目录:您是否在正确的目录下运行?
- 重新构建:尝试通过
npm run build重建项目。 - 依赖项:确保所有依赖项已安装(使用
npm install)。
可用工具
Vapi MCP 服务器提供的工具包括:
- vapi-mcp-server/src/index.ts - 主服务器文件,用于监听和处理请求。
- vapi-mcp-server/dist/index.js - 编译后的主执行文件。
📄 注意事项
⚠️ 重要提示
- 确保所有环境变量都已正确设置,并且
.env文件位于项目根目录下。- 在生产环境中使用之前,请确保服务器已经过充分测试,并配置了适当的错误处理和日志记录机制。
- 如果遇到任何问题或有进一步的疑问,请参考 Vapi 的官方文档或联系支持团队。
通过以上步骤,您可以成功将 Vapi 的语音 AI 功能与 Cursor 集成,并利用 MCP 协议进行数据交互。
Scan to contact