MCP Server Template

MCP Server Template

site icon
2025.02.10 3
TypeScriptMCP 服务器开发TypeScript 模板开发效率
MCP Server Template 是一个用于创建 Model Context Protocol (MCP) 服务器的 TypeScript 模板。该模板提供了构建 MCP 兼容服务器的基础设施,包括工具链、类型安全和最佳实践。
View on GitHub

Overview

基本能力

产品定位

MCP Server Template 是一个用于快速构建 MCP 兼容服务器的开发模板,主要面向需要实现 MCP 协议的开发者。

核心功能

  • 🚀 完整的 TypeScript 支持
  • 🏗️ 基于容器的依赖注入
  • 📦 服务化架构,包含 DataProcessor 接口
  • 🛠️ 示例工具实现及测试
  • 🧪 Vitest 测试框架
  • 📝 类型定义
  • 🔌 MCP SDK 集成

适用场景

  • 需要快速搭建 MCP 服务器的开发项目
  • 需要遵循 MCP 协议的工具开发
  • 需要类型安全和容器化架构的项目

工具列表

  1. TestClient:用于本地测试工具
  2. 提供简单的工具测试方法
  3. 支持断言工具调用结果

  4. MCP Inspector:用于可视化调试工具

  5. 提供工具测试的图形界面
  6. 实时监控请求/响应
  7. 检查工具元数据
  8. 提供交互式测试环境

常见问题解答

  • 如何测试本地 MCP 服务器? 使用 TestClient 进行单元测试或 MCP Inspector 进行可视化调试。
  • 如何添加新工具? 按照示例在 src/tools 目录下创建工具文件,并在 src/index.ts 中注册工具。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm
  2. 安装项目依赖: bash npm install

安装教程

  1. 开发模式启动(带热重载): bash npm run dev
  2. 构建项目: bash npm run build
  3. 运行测试: bash npm test
  4. 启动生产服务器: bash npm start

调试方式

  1. 使用 TestClient 进行单元测试
  2. 启动 MCP Inspector 进行可视化调试: bash npx @modelcontextprotocol/inspector node dist/index.js 然后访问 http://localhost:5173
  3. 本地测试与 Cursor 集成: bash npm run build npm run link npx example-mcp-tool

许可证

None