MCP Template Node

🚀 MCP 模板節點

MCP 模板節點是一個用於創建 Model Context Protocol (MCP) 服務器的 Node.js/TypeScript 模板。它以一個簡單的筆記管理系統為例，展示瞭如何使用 MCP 協議，為開發者提供了便捷的開發基礎。

🚀 快速開始

克隆倉庫

git clone https://github.com/Rethunk-Tech/mcp-template-node.git
cd mcp-template-node

安裝依賴

yarn install

構建並運行服務器

yarn build
yarn start

✨ 主要特性

• 嚴格類型檢查：使用 TypeScript 實現，保證代碼的類型安全性。
• 筆記管理系統：具備基本的 CRUD 操作，可輕鬆管理筆記。
• MCP 完整示例：包含工具、資源、提示等 MCP 概念的完整示例。
• 內存存儲：採用內存存儲筆記，方便快捷。
• 錯誤處理與驗證：具備全面的錯誤處理和驗證機制，增強系統穩定性。
• 單元測試：使用 Vitest 進行單元測試，確保代碼質量。
• 調試配置：提供 VS Code 調試配置，方便開發調試。
• CI 工作流：通過 GitHub Actions CI 工作流進行測試和構建。

📦 安裝指南

先決條件

• Node.js 18 或更高版本
• npm 或 yarn

📚 詳細文檔

什麼是 MCP？

Model Context Protocol (MCP) 是應用程序向大型語言模型（LLMs）提供上下文的一種標準化方式。瞭解更多信息，請訪問 MCP 協議官方網站。

項目結構

mcp-template-node/
├── build/                # 編譯後的 JavaScript 文件
├── src/
│   ├── __tests__/        # 集成測試和測試工具
│   ├── errors/           # 自定義錯誤類
│   ├── tools/            # MCP 工具實現
│   │   └── __tests__/    # 工具單元測試
│   ├── types/            # TypeScript 類型定義
│   │   └── __tests__/    # 類型測試
│   └── index.ts          # 服務器主入口文件，帶 MCP 示例
├── package.json          # 項目配置
├── tsconfig.json         # TypeScript 配置
├── eslint.config.mjs     # ESLint 平面配置
└── README.md             # 項目文檔

開發

• 即時編譯：啟動 TypeScript 編譯器的即時模式：yarn dev
• 代碼格式檢查：yarn lint
• 修復格式問題：yarn lint:fix
• 運行測試：yarn test

測試

運行測試

• 運行所有測試：

yarn test

• 以觀察模式運行測試（文件更改時重新運行）：

yarn test:watch

• 以覆蓋率運行測試：

yarn test:coverage

測試結構

• 單元測試：位於 __tests__ 文件夾中，帶註釋的示例
• 集成測試：位於 src/__tests__/integration 文件夾中
• 覆蓋率報告：生成在 coverage 文件夾中

擴展模板

配置文件

在項目根目錄創建 config.ts 文件，定義以下內容：

export interface Config {
  environment: 'development' | 'production';
  port: number;
  apiPrefix: string;
}

export const config: Config = {
  environment: process.env.NODE_ENV || 'development',
  port: parseInt(process.env.PORT) || 3000,
  apiPrefix: '/api'
};

自定義工具

在 src/tools 文件夾中創建自定義工具。

貢獻指南

1. 叉擊倉庫
2. 創建功能分支
3. 提交更改
4. 推送到個人倉庫
5. 提交拉取請求

📄 許可證

[在此處添加許可證信息]

📞 聯繫方式

• 郵箱：[在此處添加郵箱地址]
• GitHub：[在此處添加 GitHub 用戶名或鏈接]