NestJS MCP 服务器模块

一个 NestJS 模块，用于通过 模型上下文协议 (MCP)，轻松地从您的 NestJS 应用程序中公开 AI 工具、资源和提示。

借助 @rekog/mcp-nest，您可以以 NestJS 熟悉的方式定义工具、资源和提示，并充分利用依赖注入的强大功能，将您现有的代码库应用于构建复杂的、企业级的 MCP 服务器。

特性

• 🚀 多传输支持：HTTP+SSE、流式 HTTP 和 STDIO
• 🔧 工具：将 NestJS 方法作为 MCP 工具公开，具备自动发现和 Zod 验证功能
  • 🛠️ 引导式交互：通过用户输入引导的交互式工具调用
  • 🌐 HTTP 请求访问：在 MCP 处理程序中完全访问请求上下文
  • 🔐 按工具授权：为工具实现细粒度的授权
• 📁 资源：通过 MCP 资源系统提供内容和数据
• 📚 资源模板：使用参数化 URI 的动态资源
• 💬 提示：定义可重用的 AI 交互提示模板
• 🔐 基于守卫的身份验证：基于守卫的安全机制，支持 OAuth
• 🏠 内置授权服务器 — 使用内置授权服务器进行简单部署。（测试版）
• 🌐 外部授权服务器 — 使用外部授权服务器（Keycloak、Auth0 等）保护您的 MCP 服务器。
• 💉 依赖注入：在整个 MCP 组件中利用 NestJS 的依赖注入系统
• 🔍 服务器变更与监控 — 修改底层 MCP 服务器以实现自定义逻辑或监控目的。

您是否有兴趣构建 ChatGPT 小部件（使用 OpenAI SDK）或 MCP 应用程序？ 请参阅此仓库 MCP-Nest-Samples，了解如何使用 @rekog/MCP-Nest 实现这一目标。

[!TIP] 您可以使用 Context7 中的 chat 选项卡轻松了解本包。更好的是，连接 Context7 MCP 服务器，让您的 AI 代理能够访问文档并为您实现 MCP-Nest。

安装

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

可选依赖项

如果您使用内置授权服务器和 TypeORM 存储，请安装以下可选的对等依赖项：

npm install @nestjs/typeorm typeorm

快速入门

// 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, Context } from '@rekog/mcp-nest';
import { z } from 'zod';

@Injectable()
export class GreetingTool {
  @Tool({
    name: 'greeting-tool',
    description: '返回带有进度更新的问候语',
    parameters: z.object({
      name: z.string().default('World'),
    }),
  })
  async sayHello({ name }, context: Context) {
    await context.reportProgress({ progress: 50, total: 100 });
    return `Hello, ${name}!`;
  }
}

文档

• 工具指南 — 定义并公开 NestJS 方法作为 MCP 工具
• 工具发现与注册 — 工具的自动发现与手动注册
• 动态能力指南 — 在运行时以编程方式注册工具、资源和提示
• 资源指南 — 提供静态和动态内容
• 资源模板指南 — 创建参数化的资源
• 提示指南 — 构建可重用的提示模板
• 内置授权服务器 — 使用内置 OAuth 保护您的 MCP 服务器
• 外部授权服务器 — 使用外部授权服务器（Keycloak、Auth0 等）保护您的 MCP 服务器
• 服务器示例 — 包括流式 HTTP、HTTP 和 STDIO 示例，以及对 Fastify 的支持

演示环境

playground 目录包含所有功能的可运行示例。 有关详细信息，请参阅 playground/README.md。

MCP-Nest 快速上手指南

MCP-Nest 是一个 NestJS 模块，旨在帮助开发者利用 模型上下文协议 (Model Context Protocol, MCP)，轻松地将 NestJS 应用中的工具（Tools）、资源（Resources）和提示词（Prompts）暴露给 AI。它充分利用了 NestJS 的依赖注入特性，适合构建企业级 MCP 服务器。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• Node.js: 建议安装 LTS 版本。
• NestJS: 已有的 NestJS 项目或熟悉 NestJS 基础结构。
• 包管理器: npm、yarn 或 pnpm。

前置依赖说明：

• zod: 用于参数验证，必须安装版本 4 (zod@^4)。
• 可选依赖: 如果你计划使用内置的授权服务器并配合 TypeORM 存储，还需要安装 @nestjs/typeorm 和 typeorm。

安装步骤

在你的 NestJS 项目根目录下，运行以下命令安装核心依赖：

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

(可选) 如果使用内置授权服务器与 TypeORM：

npm install @nestjs/typeorm typeorm

提示：如果国内网络访问 npm 官方源较慢，建议使用淘宝镜像或其他国内加速源进行安装，例如： npm install @rekog/mcp-nest @modelcontextprotocol/sdk zod@^4 --registry=https://registry.npmmirror.com

基本使用

以下是创建一个简单 MCP 服务器的最小化示例，包含模块配置和一个简单的问候工具。

1. 定义 MCP 工具

创建一个名为 greeting.tool.ts 的文件。使用 @Tool 装饰器将方法暴露为 MCP 工具，并使用 Zod 定义参数架构。

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

@Injectable()
export class GreetingTool {
  @Tool({
    name: 'greeting-tool',
    description: 'Returns a greeting with progress updates',
    parameters: z.object({
      name: z.string().default('World'),
    }),
  })
  async sayHello({ name }, context: Context) {
    // 模拟进度报告
    await context.reportProgress({ progress: 50, total: 100 });
    return `Hello, ${name}!`;
  }
}

2. 配置 AppModule

在 app.module.ts 中导入 McpModule 并进行初始化配置，同时将定义好的 Tool 添加为提供者。

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

完成上述配置后，启动你的 NestJS 应用。MCP-Nest 会自动发现注册的 Tool，并根据配置的传输协议（如 STDIO、HTTP+SSE 等）暴露服务，供 AI 客户端调用。

更多高级功能（如资源模板、提示词、权限控制等）请参考官方文档中的 Tools Guide 和 Server examples。