Cmmv MCP

🚀 @cmmv/mcp

@cmmv/mcp モジュールは、CMMV アプリケーションのモデルコンテキストプロトコル (MCP) を実装しています。これにより、言語モデル (LLM) とアプリケーション間の標準化されたやり取りが可能になります。MCP は、AI モデルが標準形式で使用できるツールを定義するための構造化されたインターフェースを提供します。

✨ 主な機能

• LLM 統合：LLM とアプリケーション間の双方向通信を実現します。
• 柔軟な伝送：Server-Sent イベント (SSE) または標準入出力 (_stdio) を介した伝送をサポートします。
• API デコレータ方式：@MCPTool のような直感的なデコレータを使用してツールを登録します。
• Zod 検証：Zod を使用して入力モードを検証します。
• 接続管理：複数の並行接続をサポートする強力な接続処理を実装しています。

📦 インストール

pnpm を使って @cmmv/mcp をインストールします。

$ pnpm add @cmmv/mcp

📚 ドキュメント

設定

.cmmv.config.cjs ファイル内または ConfigSchema を使用して設定を行います。

import { ConfigSchema } from '@cmmv/core';

export const MCPConfig: ConfigSchema = {
  mcp: {
    name: {
      type: 'string',
      required: true,
      default: 'mcp',
    },
    version: {
      type: 'string',
      required: true,
      default: '0.0.1',
    },
    port: {
      type: 'number',
      required: true,
      default: 8765,
    },
    transport: {
      type: 'string',
      required: true,
      default: 'sse', // 選択可能な値: 'sse' または 'stdio'
    },
    jwtSecret: {
      type: 'string',
      required: false,
      default: '',
    },
    timeout: {
      type: 'number',
      required: false,
      default: 5000,
    },
    keepAliveInterval: {
      type: 'number',
      required: false,
      default: 60000,
    },
  },
};

アプリケーションの設定

Application.create メソッドを使用してアプリケーションを設定し、MCPModule とカスタムハンドラー MCPHandlers を導入します。

import { Application } from '@cmmv/core';
import { MCPModule } from '@cmmv/mcp';
import { MCPHandlers } from './handlers';

const app = new Application({
  name: 'My CMMV App',
  version: '1.0.0',
});

app.use(MCPModule);

app.listen(3000, () => {
  console.log('Application is running on http://localhost:3000');
});

ツールハンドラーの作成

@MCPTool デコレータを使用して、クラスのメソッドを LLM が呼び出せるツールとして登録します。

import { MCPTool } from '@cmmv/mcp';

@MCPTool({
  name: 'calculate',
  description: 'Calculates the sum of two numbers.',
  parameters: [
    { name: 'a', type: 'number', required: true },
    { name: 'b', type: 'number', required: true },
  ],
})
export class Calculator {
  async calculate(a: number, b: number): Promise<number> {
    return a + b;
  }
}

MCP クライアントの使用

curl コマンドを使用して MCP クライアントから登録されたツールを呼び出します。

curl -X POST http://localhost:3000/api/mcp/tools/calculate \
-H "Content-Type: application/json" \
-d '{"a": 10, "b": 20}'

ベストプラクティス

• パラメータモードを明確に定義する：Zod モードを使用して各ツールのパラメータを明確に定義します。
• 意味のある応答を提供する：LLM が効果的に理解できるように、構造化された有益な応答を返します。
• エラーを適切に処理する：ハンドラー内で強力なエラー処理メカニズムを実装します。
• セキュリティを重視する：JWT を使用してパブリックエンドポイントの認証を検討します。
• パフォーマンスを最適化する：適切な時間制限を設定し、ハンドラーが軽量かつ効率的であることを確認します。

これらのベストプラクティスに従うことで、効率的で安全かつ保守しやすい CMMV アプリケーションを構築できます。