MCP Nest

🚀 NestJS MCP モジュール

NestJS MCP モジュールは、NestJS アプリケーションで MCP サーバーを簡単に設定および管理するためのモジュールです。このモジュールを使用することで、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 の下でオープンソース化されています。