NestJS MCP 服务器模块

一个用于创建带有服务器发送事件 (SSE) 传输的 MCP (模型上下文协议) 服务器的 NestJS 模块。

<p align="center"> <img src="./image.png" height="200"> </p>

特性

• 🚀 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:
      '返回一个问候语，并模拟一个带有进度更新的长时间操作',
    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: '一个简单的问候资源',
    mimeType: 'text/plain',
  })
  // 与 SDK 不同，我们将参数和 URI 放在同一个对象中。
  async getCurrentSchema({ uri, userName }) {
    return {
      content: [
        {
          uri,
          text: `User is ${userName}`,
          mimeType: 'text/plain',
        },
      ],
    };
  }
}

你完成了！

API 端点

• GET /sse: SSE 连接端点 (如果配置了 guards，则受其保护)
• POST /messages: 工具执行端点 (如果配置了 guards，则受其保护)

提示

可以使用全局前缀来使用该模块，但推荐的方法是排除以下端点：

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

身份验证

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

1. 创建一个 Guard

实现 CanActivate 接口。该 guard 应该处理请求验证（例如，检查 JWT、API 密钥），并可以选择将用户信息附加到请求对象。

没有什么特别的，请查看 NestJS 文档以获取更多详细信息。

2. 应用 Guard

将您的 guard(s) 传递给 McpModule.forRoot 配置。该 guard(s) 将应用于 /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], // 在此处应用 guard
    }),
  ],
  providers: [GreetingTool, AuthGuard], // 确保也提供了 Guard
})
export class AppModule {}

就这样！其余的与 NestJS Guards 相同。