🚀 MCP 服务器模板

本模板全面覆盖了使用 TypeScript 和 Node.js 构建 Model Context Protocol (MCP) 服务器的需求，为开发者提供了标准化的结构和最佳实践，助力高效开发。

🚀 快速开始

独立使用模板

# 克隆此仓库
git clone https://github.com/your-org/mcp-server-template.git my-mcp-server

# 切换到项目目录
cd my-mcp-server

# 安装依赖项
npm install

# 构建项目
npm run build

# 运行示例服务器
npm start

与 LLMs 一起使用

此模板设计用于无缝集成 AI 助手（如 Claude）来帮助开发 MCP 服务器：

1. 克隆此仓库：

   git clone https://github.com/your-org/mcp-server-template.git my-mcp-server
   cd my-mcp-server
   

2. 安装依赖项：

   npm install
   

3. 复制 PROMPT_TEMPLATE.md 或 AI_ASSISTANT_PROMPT.md 中的提示，并粘贴到与 Claude 或其他 LLM 的对话中。
4. 填写您特定的 MCP 服务器需求细节。
5. 使用 LLM 实现自定义工具、资源和其他功能。
6. 使用包含的测试工具进行测试：

   npm test
   

7. 根据需要部署您的 MCP 服务器。

✨ 主要特性

MCP 服务器实现

该模板包括基本的 MCP 服务器实现，具备以下功能：

• 协议版本协商
• 能力声明
• 工具注册和执行
• 资源管理
• 错误处理
• 日志记录

工具与资源

示例实现涵盖：

• 基本工具及其参数验证
• 使用 URI 模板的资源定义
• 提示模板

测试

该模板包含测试框架，可用于：

• 工具和资源的单元测试
• 与 MCP 客户端集成测试
• 模拟外部依赖项

📦 安装指南

按照上述“快速开始”部分的步骤操作，即可完成项目的克隆、依赖安装、构建和运行。

💻 使用示例

基础用法

按照“快速开始”部分的步骤，克隆仓库、安装依赖、构建并运行示例服务器，体验 MCP 服务器的基本功能。

高级用法

与 LLMs 一起使用时，按照“快速开始与 LLMs 一起使用”部分的步骤，借助 AI 助手（如 Claude）实现自定义工具、资源和其他功能。

📚 详细文档

在 docs/ 目录中包含详尽文档，涵盖了客户端开发者、服务器开发者、Claude 用户等相关内容，以及 MCP 参考文档。

目录结构

mcp-server-template/
├── package.json           # 配置为 ES 模块
├── tsconfig.json          # TypeScript 配置
├── README.md              # 文档与使用示例
├── PROMPT_TEMPLATE.md     # 任务特定 LLM 助手的模板
├── AI_ASSISTANT_PROMPT.md # 具有深度 MCP 专业知识的 AI 助手角色提示
├── DEVELOPMENT_RULES.md   # 开发指南
├── src/
│   ├── index.ts           # 主服务器实现
│   ├── tools/             # 示例工具实现
│   │   └── example-tool.ts
│   ├── resources/         # 示例资源实现
│   │   └── example-resource.ts
│   └── utils/             # 辅助工具
│       └── error-handling.ts
├── tests/                 # 测试脚本
│   └── server.test.js
├── docs/                  # 详细文档
│   ├── client-developers.md
│   ├── server-developers.md
│   ├── claude-users.md
│   └── mcp-reference.md
└── examples/              # 示例实现
    ├── weather-server/    # 国家气象局 API 示例
    ├── github-server/     # GitHub API 示例
    └── local-files-server/ # 本地文件系统示例

🔧 技术细节

此模板提供标准化结构和最佳实践，用于开发 MCP 服务器。它包括使用 ES 模块的 TypeScript 配置、标准化目录结构、错误处理工具、测试框架、示例实现和详尽文档。通过这些技术手段，开发者可以更高效地开发和维护 MCP 服务器。

📄 许可证

文档中未提及许可证相关信息。

开发规则

遵循 DEVELOPMENT_RULES.md 中的指南，了解如何贡献代码。

示例

查看 examples/ 目录中的示例实现，学习如何使用 MCP 服务器模板。

贡献指南

阅读 CONTRIBUTING.md 了解如何为项目做出贡献。