NestJS MCP 服务器 - 模型上下文协议示例

作者: @LiusDev

此仓库演示了使用微服务架构的 Model Context Protocol (MCP) 的 NestJS 实现。它由两个主要服务组成：

1. mcp-server: 提供获取 LLM 当前时间上下文的函数
2. mcp-backend: 一个使用 LangChain.js 并与 MCP 客户端 SDK 集成以连接到 MCP 服务器的客户端

开始使用

前提条件

• Node.js (v20 或更高版本)
• npm

安装

1. 克隆仓库
2. 安装依赖项:

npm install

3. 将 .env.example 重命名为 .env 并添加您的 OpenAI API 密钥:

cp .env.example .env

然后编辑 .env 文件以包含您的 OpenAI API 密钥:

OPENAI_API_KEY=your_openai_api_key_here
OPENAI_API_URL=https://api.openai.com/v1
PORT=3001

运行服务

您需要运行这两个服务才能获得完整的功能：

启动 MCP 服务器

npm run start:dev mcp-server

这将在端口 3000（默认）上启动 MCP 服务器。

启动 MCP 后端

npm run start:dev mcp-backend

这将在端口 3001（默认）上启动 MCP 后端。

使用示例

一旦两个服务都运行起来，您可以通过向 MCP 后端发送 POST 请求来测试该功能：

示例请求

向 http://localhost:3001 发送一个带有以下 JSON 主体的 POST 请求：

{
  "message": "What time is it in Viet Nam?"
}

使用 cURL

curl -X POST http://localhost:3001 -H "Content-Type: application/json" -d "{\"message\": \"What time is it in Viet Nam?\"}"

使用 Postman

1. 创建一个新的 POST 请求到 http://localhost:3001
2. 将 Content-Type 标头设置为 application/json
3. 在请求正文中，选择 "raw" 和 "JSON"，然后输入：

   {
     "message": "What time is it in Viet Nam?"
   }
   

4. 发送请求

响应将包含越南的当前时间，该时间通过 MCP 服务器的时间上下文函数检索。

连接到多个 MCP 服务器

后端可以同时连接到多个 MCP 服务器。要添加其他服务器，请修改 apps/mcp-backend/src/mcp-backend.module.ts 中的 McpClientModule.register 配置：

McpClientModule.register({
  throwOnLoadError: true,
  prefixToolNameWithServerName: false,  // 设置为 true 以使用服务器名称作为工具名称的前缀
  additionalToolNamePrefix: '',
  mcpServers: {
    myServer: {
      transport: 'sse',
      url: 'http://localhost:3000/sse',
      useNodeEventSource: true,
      reconnect: {
        enabled: true,
        maxAttempts: 5,
        delayMs: 2000,
      },
    },
    // 在此处添加其他服务器
    anotherServer: {
      transport: 'sse',
      url: 'http://localhost:4000/sse',  // 另一个服务器的不同端口
      useNodeEventSource: true,
      reconnect: {
        enabled: true,
        maxAttempts: 5,
        delayMs: 2000,
      },
    },
  },
}),

连接到多个服务器时：

• 考虑设置 prefixToolNameWithServerName: true 以避免工具名称冲突
• 确保每个服务器在 mcpServers 对象中都有一个唯一的键
• 确保每个服务器都在不同的端口上运行

MCP 客户端将自动从所有配置的服务器获取工具，并使它们可供 LLM 使用。

架构

• mcp-server: 通过 Model Context Protocol 公开工具，包括获取当前时间的函数
• mcp-backend: 连接到 MCP 服务器，检索可用工具，并将其与 LangChain.js 一起使用以处理用户查询

使用的技术

• NestJS
• LangChain.js
• Model Context Protocol (MCP)
• @langchain/mcp-adapters: LangChain.js 的 MCP 客户端适配器
• @rekog/mcp-nest: NestJS 的 MCP 服务器实现

项目结构

mcp-server/
├── apps/
│   ├── mcp-server/       # MCP 服务器实现
│   └── mcp-backend/      # MCP 客户端实现
├── dist/                 # 编译后的输出
├── node_modules/
├── .env                  # 环境变量
└── package.json

许可证

此项目根据 UNLICENSED 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。