基本能力
产品定位
MCP-Server-Starter 是一个用于快速构建 MCP 服务器的 TypeScript 模板,旨在简化 AI 代理与工具交互的开发过程。
核心功能
- MCP 服务器:作为桥梁,将 API、数据库和代码库暴露给外部 AI 主机
- MCP 客户端:使用 TypeScript SDK 进行类型安全的交互
- MCP 主机:协调服务器和客户端之间的请求,确保数据流畅
- 工具响应格式:标准化的工具响应格式,支持多种内容类型
- 安全实践:包括输入验证、错误处理和资源管理
- 高级功能:支持流式响应、自定义内容类型和异步工具执行
适用场景
- AI 代理与工具集成
- 开发 AI 辅助工具
- 构建标准化 API 接口
- 创建可复用的计算逻辑
工具列表
- 计算器工具:示例计算器工具实现
- REST API 工具:示例 REST API 工具实现
常见问题解答
- 如何验证输入参数?使用 Zod 模式进行严格验证
- 如何处理错误?实现适当的错误边界并返回用户友好的错误消息
- 如何管理资源?实现适当的清理程序和处理终止信号
使用教程
使用依赖
- Node.js (v18 或更高版本)
- npm (v7 或更高版本)
- VS Code 与 Dev Containers 扩展
安装教程
- 克隆模板仓库
- 在 VS Code 中使用 Dev Containers 打开项目
- 安装依赖:
bash
npm install - 构建项目:
bash
npm run build
调试方式
- 使用检查器模式:
bash
npm run inspector - 监视模式:
bash
npm run watch - 单元测试:使用 Jest 测试工具
高级功能
流式响应
支持长时间运行操作的流式响应
自定义内容类型
可以定义专门数据的自定义内容类型
异步工具执行
实现适当的异步处理
测试与调试
单元测试
使用 Jest 测试工具
调试工具
- MCP 检查器:提供实时检查
- 日志记录:实现适当的日志记录
- 错误跟踪:处理未捕获的异常
传输配置
支持多种传输协议:
- stdio 传输
- WebSocket 传输
- 自定义传输
服务器能力
配置服务器能力,包括工具支持、流式支持和自定义内容类型
与 MCP 主机集成
支持多种 AI 平台:
- Claude Desktop
- Cursor
- Windsurf
- Cline
- TypeScript
开发最佳实践
- 使用 TypeScript
- 采用一致的模式实现工具
- 包含全面的文档
- 利用检查器进行调试
- 部署前进行全面测试
- 遵循 MCP 最佳实践