MCP Server Template

🚀 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 瞭解如何為項目做出貢獻。