Nest MCP Sse

🚀 Nest-mcp-sse

Nest-mcp-sse 是一個用於在 NestJS 工程中快速開發 SSE（Server-Sent Events）傳輸類型 McpServer 的動態模塊。它簡化了與 McpServer 的交互，讓開發者無需處理連接運輸、生命週期管理和消息傳遞等繁瑣任務，從而專注於 MCP 工具的核心功能開發。該模塊採用最小封裝方式，降低學習和使用成本，同時保證高性能和靈活性。

🚀 快速開始

Nest-mcp-sse 能助力你在 NestJS 項目中快速搭建 SSE 傳輸類型的 McpServer。下面為你詳細介紹使用步驟。

✨ 主要特性

• 快速創建 MCP 服務器：通過簡單的配置即可快速啟動 MCP 服務器。
• 支持多個實例管理：允許同時管理和運行多個 McpServer 實例。
• 自動處理 SSE 連接生命週期：模塊內置了對 SSE 連接的自動管理功能，簡化了連接建立和維護過程。

📦 安裝指南

你可以使用以下任意一種包管理工具來安裝 nest-mcp-sse：

npm install nest-mcp-sse
# 或者
yarn add nest-mcp-sse
# 或者
pnpm add nest-mcp-sse

💻 使用示例

基礎用法

1. 導入模塊

在你的 NestJS 模塊中導入 McpModule：

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

@Module({
  imports: [McpModule.register({
    controllerBaseUrl: 'api/mcp',
    mcpServerConfigs: [
      {
        serverId: 'default-server', // MCP Server 的唯一標識符
        serverInfo: {
          name: 'Default Server', // 直接傳遞給 MCP TS-SDK 的 McpServer 類的第一個參數
          options: { /* 直接傳遞給 MCP TS-SDK 的 McpServer 類的第二個參數 */ }
        }
      }
    ]
  })],
})
export class AppModule {}

2. 操作 McpServer 實例

你可以通過 McpServerService 來管理多個 McpServer 實例：

import { McpServerService } from 'nest-mcp-sse';

@Injectable()
export class MyService {
  constructor(
    private readonly mcpServerService: McpServerService,
  ) {}

  // 註冊一個新的 MCP Server 實例
  async registerMcpServer() {
    const server = await this.mcpServerService.registerServer({
      serverId: 'new-server',
      serverInfo: { /* 配置參數 */ },
    });
    return server;
  }

  // 獲取指定 ID 的 MCP Server 實例
  getMcpServer(serverId: string) {
    return this.mcpServerService.getServer(serverId);
  }

  // 檢查是否已註冊某個 MCP Server 實例
  hasMcpServer(serverId: string) {
    return this.mcpServerService.hasServer(serverId);
  }
}

3. 手動註冊服務器實例

如果你希望手動管理 McpServer 的連接，可以使用以下方法：

import { McpServerService } from 'nest-mcp-sse';

// 註冊一個新的 MCP Server 實例
const server = await mcpServerService.registerServer({
  serverId: 'manual-server',
  serverInfo: { /* 配置參數 */ },
});

// 連接 MCP Server 到傳輸層
await mcpServerService.connect('manual-server', transportInstance);

高級用法

自動創建的服務器端點

模塊會自動為每個 McpServer 實例創建以下兩個端點：

• SSE 連接端點：{controllerBaseUrl}/{serverId}/connect
  • 示例 URL：http://localhost:3000/api/mcp/default-server/connect
• 消息處理端點：{controllerBaseUrl}/{serverId}/messages
  • 示例 URL：http://localhost:3000/api/mcp/default-server/messages

高級配置

自定義端點名稱

你可以在模塊註冊時自定義 SSE 和消息端點的名稱：

McpModule.register({
  controllerBaseUrl: 'api/mcp',
  sseEndpoint: 'custom-sse', // 默認為 'sse'
  messagesEndpoint: 'custom-messages', // 默認為 'messages'
  mcpServerConfigs: [
    {
      serverId: 'default-server',
      serverInfo: { /* 配置參數 */ },
    }
  ],
});

其他配置選項

• 傳輸層管理：模塊支持自定義傳輸層的實現，允許開發者根據需求擴展功能。
• 消息處理：可以通過插件機制擴展 McpServer 的消息處理能力。

📚 詳細文檔

完整的使用示例可以參考 官方文檔 或者模塊的 示例項目。

📄 許可證

文檔中未提及許可證相關信息。

🤝 貢獻與支持

• 如果你發現任何問題或有改進建議，請提交 Issue。
• 歡迎通過 Pull Request 為項目貢獻力量！