MCP Server Node

🚀 使用 Node.js 創建 MCP 服務器

本項目展示瞭如何使用 Node.js 創建一個 MCP 服務器，可將自定義工具集成到 AI 輔助開發環境中，提供了加法和獲取 API 密鑰兩個實用工具，助力提升開發效率。

🚀 快速開始

項目概述

MCP（模型上下文協議） 是一個框架，允許您將自定義工具集成到 AI 輔助開發環境（如 Cursor AI）中。MCP 服務器通過暴露功能（例如數據檢索或代碼分析），使得基於 LLM 的 IDE 可以按需調用這些工具。瞭解 MCP 的更多信息，請參閱 模型上下文協議介紹。

本項目演示了一個使用 Node.js 創建的 MCP 服務器，提供兩個基本工具。其中一個工具 add 接受兩個數字並返回它們的和，另一個工具 getApiKey 從環境變量（通過 API_KEY 變量）中檢索 API 密鑰。

項目要求

• Node.js: 需要版本 20 或更高版本。

✨ 主要特性

• MCP 集成：將功能暴露到基於 LLM 的 IDE 中。
• 加法工具：接受兩個數字參數並返回它們的和。
• 環境變量檢索：展示如何從配置文件加載示例環境變量。
• 輸入驗證：使用 Zod 進行模式驗證。
• 標準 I/O 傳輸：通過 StdioServerTransport 連接，以便與開發環境集成。

📦 安裝指南

克隆倉庫

git clone <repository_url>
cd <repository_directory>

安裝依賴項

您可以通過以下兩種方式之一安裝項目依賴項：

• 選項 1：使用現有的 package.json 進行安裝 只需運行：

  npm install
  

• 選項 2：手動安裝依賴項 如果您願意，可以刪除現有的 package.json 並手動安裝所需的包：

  npm install @modelcontextprotocol/typescript-sdk zod
  

  然後複製以下代碼到一個新的 index.ts 文件中：

  import { McpServer } from "@modelcontextprotocol/typescript-sdk";
  import { ServerTransportStdio } from "@modelcontextprotocol/typescript-sdk";
  
  // 定義 add 工具的 schema
  const addSchema = {
    inputs: {
      a: "number",
      b: "number"
    },
    output: "string"
  };
  
  // 定義 getApiKey 工具的 schema
  const getApiKeySchema = {
    inputs: {},
    output: "string"
  };
  
  const server = new McpServer({
    name: "node-mcp-server",
    version: "1.0.0",
    transport: new ServerTransportStdio()
  });
  
  // 註冊 add 工具
  server.registerTool("add", {
    schema: addSchema,
    async run(inputs) {
      return inputs.a + inputs.b;
    }
  });
  
  // 註冊 getApiKey 工具
  server.registerTool("getApiKey", {
    schema: getApiKeySchema,
    async run() {
      return process.env.API_KEY || "no-api-key";
    }
  });
  
  // 啟動服務器
  server.start();
  

📚 詳細文檔

配置文件

將以下內容添加到項目根目錄中創建一個 server.json 文件：

{
  "name": "node-mcp-server",
  "version": "1.0.0",
  "tools": {
    "add": {
      "description": "計算兩個數字的和",
      "inputs": {
        "a": {
          "type": "number",
          "required": true
        },
        "b": {
          "type": "number",
          "required": true
        }
      },
      "output": "string"
    },
    "getApiKey": {
      "description": "獲取 API 密鑰",
      "inputs": {},
      "output": "string"
    }
  }
}

使用方法

1. 設置環境變量 API_KEY：

   export API_KEY=your_api_key_here
   

2. 運行服務器：

   node index.ts
   

3. 現在，您可以使用以下命令來測試工具：

   mcp-client add --a 10 --b 20
   mcp-client getApiKey
   

什麼是 MCP？

模型上下文協議 (MCP) 提供了一種標準化方法，用於將自定義工具集成到 AI 輔助開發環境中。使用 MCP，您可以定義執行特定任務的工具——例如檢索外部數據、驗證代碼或 enforcing 編碼標準——並且 IDE 中的 AI 助手可以根據上下文自動調用這些工具。這有助於提高開發人員生產力、確保一致的質量並簡化工作流程。

📖 參考資料 & 資源

• 模型上下文協議: TypeScript SDK
• 在 5 分鐘內使用您的 MCP 在 Cursor 上
• 模型上下文協議介紹

📄 許可證

本項目根據 MIT License 許可。