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接続の自動管理機能が組み込まれており、接続の確立と維持のプロセスを簡素化します。

📦 インストール

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クラスの2番目のパラメータに渡されます */ }
        }
      }
    ]
  })],
})
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インスタンスに対して以下の2つのエンドポイントを自動的に作成します。

• 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を通じてプロジェクトに貢献することを歓迎します！