Nestjs MCP

🚀 NestJS MCP モジュール日本語ドキュメント

NestJS MCP モジュールは、Model Context Protocol (MCP) 用に構築された最初の公式 NestJS モジュールです。このモジュールを使用すると、MCP 標準に準拠した方法でリソース、ツール、プロンプトを迅速に作成、管理、使用することができます。また、NestJS の他の機能とシームレスに統合されるため、開発者は効率的で拡張性の高いアプリケーションの構築に集中することができます。

✨ 主な機能

• 即挿即用：簡単なデコレータを使用することで、サービスを MCP リソース、ツール、またはプロンプトとして迅速に登録できます。
• 複数のコンテンツタイプをサポート：テキスト、JSON、ファイルなどの一般的なコンテンツタイプを自動的に処理する機能が組み込まれています。
• 拡張可能：モジュールの構造が明確で、必要に応じて拡張やカスタマイズが容易です。

📦 インストール

npm を使用したインストール

npm install @nestjs/mcp --save

Yarn を使用したインストール

yarn add @nestjs/mcp

pnpm を使用したインストール

pnpm add @nestjs/mcp

🚀 クイックスタート

以下は、NestJS アプリケーションで MCP モジュールをすぐに使い始めるための簡単な例です。

プロジェクト構造の作成

your_project/
├── src/
│   ├── decorators/
│   │   └── mcp.decorators.ts
│   ├── modules/
│   │   └── mcp.module.ts
│   └── app.controller.ts

依存関係のインストール

以下の依存関係をインストールしてください。

npm install @nestjs/mcp @nestjs/common @nestjs/core express

📚 ドキュメント

プロジェクト構造と設定オプション

mcp.module.ts で、MCP モジュールを選択的に使用して設定することができます。

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

@Module({
  imports: [
    McpModule.forRoot({
      // オプションのルートモジュール設定オプション
    }),
  ],
})
export class McpModule {}

また、環境変数で MCP モジュールの関連オプションを設定することもできます。

# .env ファイルの例
NCP_API_KEY=your_api_key_here
NCP_BASE_URL=https://api.example.com

リソーステンプレートの例

以下はリソーステンプレートの例です。

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

@Module({
  imports: [McpModule],
})
export class MyModule {}

// 例のリソース定義
interface MyResource {
  id: string;
  name: string;
}

@McpResource('my-resource', '/api/my-resources')
export class MyResourceController {
  @Post()
  async create(@Body() resource: MyResource) {
    // 作成ロジックを実装
  }

  @Get(':id')
  async get(@Param('id') id: string) {
    // 取得ロジックを実装
  }
}

ツールメソッド

@McpTool デコレータの使用

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

@Module({
  imports: [McpModule],
})
export class MyModule {}

// 例のツール定義
interface MyTool {
  id: string;
  name: string;
}

@McpTool('my-tool', '/api/my-tools')
export class MyToolController {
  @Post()
  async execute(@Body() tool: MyTool) {
    // 実行ロジックを実装
  }
}

ツールの呼び出し

import { McpTools } from '@nestjs/mcp';

// ツールを呼び出す例のメソッド
async function callMyTool() {
  const result = await McpTools.myTool.execute({
    id: '1',
    name: 'Test Tool',
  });

  console.log('ツールの実行結果:', result);
}

プロンプトシステム

@McpPrompt デコレータの使用

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

@Module({
  imports: [McpModule],
})
export class MyModule {}

// 例のプロンプト定義
interface MyPrompt {
  id: string;
  input: string;
}

@McpPrompt('my-prompt', '/api/my-prompts')
export class MyPromptController {
  @Post()
  async handle(@Body() prompt: MyPrompt) {
    // 処理ロジックを実装
  }
}

モジュールオプションの設定

mcp.module.ts で、MCP モジュールを選択的に使用して設定することができます。

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

@Module({
  imports: [
    McpModule.forRoot({
      apiKey: 'your_api_key_here',
      baseUrl: 'https://api.example.com',
    }),
  ],
})
export class McpModule {}

環境変数の設定

mcp.module.ts で環境変数を読み込むことができます。

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

@Module({
  imports: [
    McpModule.forRoot({
      loadEnv: true,
    }),
  ],
})
export class McpModule {}

開発と貢献ガイド

リポジトリのクローン

git clone git@github.com:nestjsorg/mcp.git
cd mcp
npm install

テストの実行

npm run test

コードの提出

標準的なコミット規約に従い、コードスタイルとドキュメントの一貫性を確保してください。

📄 ライセンス

MCP モジュールは MIT ライセンスに準拠しています。詳細は LICENSE ファイルを参照してください。

リンク

• 公式ドキュメント: https://nestjs.com/mcp/docs
• GitHub リポジトリ: https://github.com/nest