@prosodyai/mcp-docs MCP 服务说明文档
1. 服务概述
一句话简介：暴露ProsodyAI文档、SDK参考、REST API参考(OpenAPI)和精选实现配方的MCP服务器，让AI编码代理能够正确实现ProsodyAI集成。
- 服务名称：@prosodyai/mcp-docs
- 版本号：最新版本
- 开发者/提供方：ProsodyAI
- 协议类型：MCP (Model Context Protocol)
2. 核心功能
该MCP服务提供以下主要功能：
- search_docs：一次性搜索文档、SDK README、配方和OpenAPI
- list_docs：按部分浏览所有内容（docs、sdks、recipes、api）
- read_doc：根据ID获取文档/README/配方的完整内容
- list_recipes：列出端到端实现指南
- list_endpoints：列出捆绑的OpenAPI规范中的REST端点，支持按标签过滤
- get_endpoint：获取单个端点的完整OpenAPI操作对象
- get_openapi：获取整个捆绑的OpenAPI 3规范
- get_overview：获取一页介绍，开始集成时首先阅读
3. 使用场景
该服务适合在以下情况下使用：
- AI编码代理需要正确实现ProsodyAI集成
- 查找ProsodyAI SDK使用方法和API参考
- 获取端到端的实现配方指南
- 浏览REST API端点和OpenAPI规范
- 在Node/Next.js/浏览器应用中集成ProsodyAI
4. 接入方式
4.1 服务端点
Stdio传输（本地）：适用于本地代理（Cursor、Claude Code、Cline等）
HTTP传输（Streamable HTTP）：适用于远程/托管代理
HTTP默认端口：localhost:3333/mcp
4.2 认证与权限
公开服务，无需认证
4.3 数据格式
请求和响应均采用JSON格式
每个条目也作为MCP资源暴露在prosodyai://<section>/<id>
4.4 服务器配置
Stdio方式（本地）：
{ "mcpServers": { "prosodyai-docs": { "command": "npx", "args": ["-y", "@prosodyai/mcp-docs"] } } }HTTP方式（远程）：
{ "mcpServers": { "prosodyai-docs": { "url": "https://prosodyai-docs.vercel.app/mcp" } } }5. 接口定义
| 工具名称 | 功能描述 | 参数 | 返回值 |
|---|---|---|---|
| search_docs | 搜索文档 | 搜索关键词 | 匹配的文档、SDK README、配方和OpenAPI结果 |
| list_docs | 浏览所有内容 | 部分名称（docs/sdks/recipes/api） | 该部分的所有条目列表 |
| read_doc | 获取文档内容 | 文档ID | 文档完整内容 |
| list_recipes | 列出实现配方 | 无 | 端到端实现指南列表 |
| list_endpoints | 列出REST端点 | 可选标签过滤器 | REST端点列表 |
| get_endpoint | 获取端点详情 | 端点ID | 完整OpenAPI操作对象 |
| get_openapi | 获取OpenAPI规范 | 无 | 完整OpenAPI 3规范 |
| get_overview | 获取概览 | 无 | 一页介绍内容 |
6. 快速开始
6.1 环境要求
- Node.js 环境
- npm 包管理器
- 支持MCP协议的客户端
6.2 示例代码
本地运行：
npm install npm run build npm run start:stdio # stdio MCP客户端 npm run start:http # HTTP服务，localhost:3333/mcp内置配方列表：
recipes/sdk-typescript-quickstart— 在Node/Next.js/浏览器应用中添加ProsodyAIrecipes/livekit-realtime-agent— 带韵律驱动适应的实时语音代理recipes/langchain-agent— 将韵律作为LangChain工具使用recipes/browser-streaming— 从浏览器流式传输麦克风音频recipes/kpi-flow— 定义自定义KPI并关闭反馈循环recipes/rest-api-integration— 不使用SDK的直接REST集成
7. 注意事项
- 支持两种传输方式：stdio（本地）和HTTP（远程）
- 可部署到Vercel/Cloud Run/Fly/Railway等平台
- 提供Docker支持（单阶段Node 20-slim镜像）
- 健康检查端点：
/healthz - 许可证：MIT