Nestjs MCP Server Module Xtd

🚀 使用 NestJS 创建 MCP 服务器模块

这是一个用于创建支持 Server-Sent Events (SSE) 传输的 Model Context Protocol (MCP) 服务器的 NestJS 模块，能够为流式处理和工具执行提供支持。

✨ 主要特性

• 🚀 采用 SSE 传输，用于流式处理和工具执行。
• 🔍 可自动发现和注册 tool 和 resource。
• 💯 基于 Zod 进行请求验证。
• 📊 支持进度通知。
• 🔒 基于 Guard 实现身份验证。

📦 安装指南

使用以下命令进行安装：

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

🚀 快速开始

1. 导入模块

// 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 {}

2. 定义工具和资源

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

@Injectable()
export class GreetingTool {
  constructor() {}

  @Tool({
    name: 'hello-world',
    description:
      'Returns a greeting and simulates a long operation with progress updates',
    parameters: z.object({
      name: z.string().default('World'),
    }),
  })
  async sayHello({ name }, 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: 'A simple greeting resource',
    mimeType: 'text/plain',
  })
  // 不同于 SDK，我们将参数和 URI 放在同一个对象中。
  async getCurrentSchema({ uri, userName }) {
    return {
      content: [
        {
          uri,
          text: `User is ${userName}`,
          mimeType: 'text/plain',
        },
      ],
    };
  }
}

完成以上步骤，您就完成了基本配置。

📚 详细文档

API 端点

• GET /sse：SSE 连接端点（受 Guard 保护，如果已配置）
• POST /messages：工具执行端点（受 Guard 保护，如果已配置）

提示

可以使用全局前缀排除这些端点，但推荐的方式是：

app.setGlobalPrefix('/api', { exclude: ['sse', 'messages'] });

认证

可以使用标准的 NestJS Guards 来保护 MCP 端点。

1. 创建一个 Guard

实现 CanActivate 接口。该守卫应处理请求验证（例如，检查 JWT、API 密钥）并可选地将用户信息附加到请求对象中。此部分与 NestJS 文档中的内容无异。

2. 应用该 Guard

将您的守卫传递给 McpModule.forRoot 配置。该守卫将应用于 /sse 和 /messages 端点。

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

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
      guards: [AuthGuard], // 在这里应用守卫
    }),
  ],
  providers: [GreetingTool, AuthGuard], // 确保守卫也被提供
})
export class AppModule {}

其余的内容与 NestJS Guards 相同。