NestJS MCP Server Module

NestJS MCP サーバーモジュール

Server-Sent Events（SSE）トランスポートを使用して MCP（Model Context Protocol）サーバーを作成するための NestJS モジュールです。

機能

• 🚀 ストリーミングとツール実行に対応した SSE トランスポート
• 🔍 tool と resource の自動検出と登録
• 💯 Zod ベースのリクエスト検証
• 📊 進行状況の通知
• 🔒 ガードベースの認証

インストール

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

クイックスタート

1. モジュールをインポートする

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

2. ツールとリソースを定義する

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

@Injectable()
export class GreetingTool {
  constructor() {}

  @Tool({
    name: 'hello-world',
    description:
      'Returns a greeting and simulates a long operation with progress updates',
    parameters: z.object({
      name: z.string().default('World'),
    }),
  })
  async sayHello({ name }, context: Context) {
    const greeting = `Hello, ${name}!`;

    const totalSteps = 5;
    for (let i = 0; i < totalSteps; i++) {
      await new Promise((resolve) => setTimeout(resolve, 500));

      // Send a progress update.
      await context.reportProgress({
        progress: (i + 1) * 20,
        total: 100,
      } as Progress);
    }

    return {
      content: [{ type: 'text', text: greeting }],
    };
  }

  @Resource({
    uri: 'mcp://hello-world/{userName}',
    name: 'Hello World',
    description: 'A simple greeting resource',
    mimeType: 'text/plain',
  })
  // Different from the SDK, we put the parameters and URI in the same object.
  async getCurrentSchema({ uri, userName }) {
    return {
      content: [
        {
          uri,
          text: `User is ${userName}`,
          mimeType: 'text/plain',
        },
      ],
    };
  }
}

これで完了です！

API エンドポイント

• GET /sse：SSE 接続エンドポイント（設定されている場合、ガードで保護されます）
• POST /messages：ツール実行エンドポイント（設定されている場合、ガードで保護されます）

ヒント

グローバルプレフィックスを使用することもできますが、次のようにこれらのエンドポイントを除外する方法をおすすめします。

app.setGlobalPrefix('/api', { exclude: ['sse', 'messages'] });

認証

標準的な NestJS ガードを使用して MCP エンドポイントを保護できます。

1. ガードを作成する

CanActivate インターフェースを実装します。ガードではリクエストの検証（JWT や API キーの確認など）を行い、必要に応じてリクエストオブジェクトにユーザー情報を追加します。

特別なことはありません。詳しくは NestJS のドキュメントを確認してください。

2. ガードを適用する

McpModule.forRoot の設定にガードを渡します。ガードは /sse と /messages の両方のエンドポイントに適用されます。

// app.module.ts
import { Module } from '@nestjs/common';
import { McpModule } from '@rekog/mcp-nest';
import { GreetingTool } from './greeting.tool';
import { AuthGuard } from './auth.guard';

@Module({
  imports: [
    McpModule.forRoot({
      name: 'my-mcp-server',
      version: '1.0.0',
      guards: [AuthGuard], // Apply the guard here
    }),
  ],
  providers: [GreetingTool, AuthGuard], // Ensure the Guard is also provided
})
export class AppModule {}

これで完了です！あとは通常の NestJS ガードと同じです。