基本能力
产品定位
Boilerplate MCP Server 是一个开发框架,用于构建自定义 MCP 服务器,使 AI 系统能够安全、上下文感知地连接外部工具和数据源。
核心功能
- 生产就绪架构:采用分层架构,清晰分离 CLI、工具、控制器和服务。
- 类型安全:基于 TypeScript 构建,提升开发体验和代码质量。
- 工作示例:包含一个完整的 IP 查询工具,展示从 CLI 到 API 集成的完整模式。
- 测试框架:提供单元测试和 CLI 集成测试基础设施,包括覆盖率报告。
- 开发工具:预配置 ESLint、Prettier、TypeScript 等工具,支持 MCP 服务器开发。
适用场景
- 开发自定义 MCP 服务器,连接 AI 助手与外部 API 或数据源。
- 快速构建和测试新的 MCP 工具。
- 提供标准化架构和开发流程,提升团队协作效率。
工具列表
- IP 查询工具:示例工具,用于查询 IP 地址的详细信息。
- MCP Inspector:可视化工具,用于测试工具和查看请求/响应详情。
常见问题解答
- 如何调试工具?:使用 MCP Inspector 或启用调试日志(
DEBUG=true npm run dev:server
)。 - 如何添加新工具?:按照开发指南中的步骤定义服务、控制器、工具和 CLI 支持。
使用教程
使用依赖
- Node.js (>=18.x):下载链接
- Git:用于版本控制
安装教程
```bash
克隆仓库
git clone https://github.com/aashari/boilerplate-mcp-server.git
cd boilerplate-mcp-server
安装依赖
npm install
```
调试方式
```bash
启动开发服务器(支持热重载和 MCP Inspector)
npm run dev:server
测试示例工具
npm run dev:cli -- get-ip-details
npm run dev:cli -- get-ip-details 8.8.8.8
启用调试日志
DEBUG=true npm run dev:server
```