NestJS MCP 模块

快速入门

要开始使用 NestJS MCP 模块，请按照以下步骤进行：

安装模块

通过 npm 或 yarn 安装模块：

npm install @rekog/mcp-nest
# 或者
yarn add @rekog/mcp-nest

初始化 MCP 服务器

在您的 NestJS 应用中初始化 MCP 服务器：

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

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

安装与配置

安装

npm install @rekog/mcp-nest
# 或者
yarn add @rekog/mcp-nest

配置

在 app.module.ts 中导入模块：

import { McpModule } from '@rekog/mcp-nest';

使用示例

示例用法

创建一个工具：

import { McpTool, McpContext } from '@rekog/mcp-nest';

export class MyAwesomeTool implements McpTool {
  async execute(context: McpContext): Promise<void> {
    // 在此处实现您的工具逻辑
  }
}

注册工具：

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

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

Playground

playground 目录包含快速测试 MCP 和 @rekog/mcp-nest 功能的示例。请参考 playground/README.md 了解更多细节。

配置选项

McpModule.forRoot() 方法接受一个 McpOptions 对象来配置服务器。以下是可用的选项：

拦截器

创建一个拦截器：

import { McpInterceptor } from '@rekog/mcp-nest';

export class MyAwesomeInterceptor implements McpInterceptor {
  intercept(context: any, next: Function): any {
    // 在此处实现您的拦截逻辑
    return next();
  }
}

注册拦截器：

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

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

开发指南

创建工具

创建一个简单的工具：

import { McpTool, McpContext } from '@rekog/mcp-nest';

export class HelloTool implements McpTool {
  async execute(context: McpContext): Promise<void> {
    await context.send('Hello, World!');
  }
}

注册工具：

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

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

创建拦截器

创建一个简单的拦截器：

import { McpInterceptor } from '@rekog/mcp-nest';

export class LoggingInterceptor implements McpInterceptor {
  intercept(context: any, next: Function): any {
    console.log('请求开始');
    const result = next();
    console.log('请求结束');
    return result;
  }
}

注册拦截器：

import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';

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

文档

详细文档请访问 NestJS MCP 模块官方文档。

维护者

• 您的名字

许可证

项目在 MIT License 下开源。