NestJS MCP Server 模块使用教程

1. 项目目录结构

本项目是基于 NestJS 的 MCP (Model Context Protocol) 服务器模块，以下是其目录结构的基本介绍：

MCP-Nest/
├── .github/            # GitHub 工作流程目录
│   └── workflows/
├── src/               # 源代码目录
│   ├── controllers/
│   ├── services/
│   ├── tools/         # 工具类目录
│   ├── resources/     # 资源类目录
│   └── app.module.ts  # 应用模块文件
├── tests/             # 测试代码目录
├── .gitignore         # Git 忽略文件
├── .npmignore         # npm 忽略文件
├── prettierrc         # Prettier 配置文件
├── LICENSE            # 许可证文件
├── README.md          # 项目说明文件
├── jest.config.js     # Jest 配置文件
├── package-lock.json  # npm 包锁定文件
├── package.json       # npm 包配置文件
└── tsconfig.json      # TypeScript 配置文件

2. 项目启动文件介绍

项目的启动文件是 src/app.module.ts，它定义了 NestJS 应用的模块结构。

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

在这个文件中，我们导入了 McpModule 并通过 forRoot 方法配置了 MCP 服务器的基本信息，同时声明了 GreetingTool 工具类。

3. 项目配置文件介绍

项目的配置主要通过 McpModule.forRoot 方法进行，以下是一些可配置的选项：

• name: MCP 服务器的名称。
• version: MCP 服务器的版本号。
• transport: 通信传输类型，例如 HTTP+SSE 或 STDIO。
• sse: SSE (Server-Sent Events) 配置，包括是否启用 (pingEnabled) 和心跳间隔 (pingIntervalMs)。

例如，以下配置启用了 SSE 并设置了 30 秒的心跳间隔：

McpModule.forRoot({
  name: 'my-mcp-server',
  version: '1.0.0',
  sse: {
    pingEnabled: true,
    pingIntervalMs: 30000,
  },
}),

以上是 NestJS MCP Server 模块的基本使用教程，您可以根据自己的需求进一步扩展和配置项目。