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 许可。