NestJS MCP Server 模块使用教程

1. 项目介绍

MCP-Nest 是一个为 NestJS 应用程序设计的模块，它使得开发者可以轻松地通过 Model Context Protocol (MCP) 来暴露工具、资源和提示。该模块处理了设置 MCP 服务器的大部分复杂性，允许开发者以熟悉的方式定义工具、资源和提示，并利用 NestJS 的依赖注入功能来使用现有的服务。

2. 项目快速启动

安装

首先，你需要安装 @rekog/mcp-nest 和相关依赖。

npm install @rekog/mcp-nest @modelcontextprotocol/sdk zod

创建 NestJS 应用模块

接下来，创建一个新的模块，并在其中导入 McpModule。

// app.module.ts
import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';
import { GreetingTool } from './greeting.tool';

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
    }),
  ],
  providers: [GreetingTool],
})
export class AppModule {}

定义工具和资源

创建一个工具类，并定义相关资源。

// greeting.tool.ts
import { Injectable } from '@nestjs/common';
import { Tool, Resource, Context } from '@rekog/mcp-nest';
import { z } from 'zod';
import { Progress } from '@modelcontextprotocol/sdk/types';

@Injectable()
export class GreetingTool {
  @Tool({
    name: 'hello-world',
    description: '返回问候语并模拟长时间操作，同时更新进度',
    parameters: z.object({
      name: z.string().default('World'),
    }),
  })
  async sayHello({ name }: { name: string }, context: Context) {
    const greeting = `Hello, ${name}!`;
    const totalSteps = 5;
    for (let i = 0; i < totalSteps; i++) {
      await new Promise((resolve) => setTimeout(resolve, 500));
      // 发送进度更新
      await context.reportProgress({
        progress: (i + 1) * 20,
        total: 100,
      } as Progress);
    }
    return {
      content: [{ type: 'text', text: greeting }],
    };
  }

  @Resource({
    uri: 'mcp://hello-world/{userName}',
    name: 'Hello World',
    description: '一个简单的问候资源',
    mimeType: 'text/plain',
  })
  async getCurrentSchema({ uri, userName }: { uri: string; userName: string }) {
    return {
      content: [
        { uri, text: `User is ${userName}`, mimeType: 'text/plain' },
      ],
    };
  }
}

启动应用

使用以下命令启动你的 NestJS 应用：

npm run start

3. 应用案例和最佳实践

• 使用 HTTP+SSE：通过 HTTP 和 Server-Sent Events (SSE) 来与 MCP 客户端通信。
• 使用 STDIO：在独立的 NestJS 应用程序中使用 STDIO 传输与 MCP 客户端通信。
• 安全性：使用 NestJS 的守卫 (Guards) 来保护 MCP 端点，例如通过 JWT 或 API 密钥进行验证。
• SSE Ping 服务：配置 SSE ping 服务以维护长连接，防止客户端超时。

4. 典型生态项目

目前没有具体的生态项目列出，但开发者可以探索使用 MCP-Nest 与其他 MCP 客户端集成，例如 IDE 插件、移动应用或其他 Web 应用程序。通过这种方式，可以创建一个统一的交互界面，用于在不同环境中访问 AI 服务和工具。