Cmmv MCP

🚀 @cmmv/mcp

@cmmv/mcp 模塊實現了 CMMV 應用程序的模型上下文協議 (MCP)，允許語言模型 (LLM) 和應用程序之間進行標準化交互。MCP 提供了結構化的接口，用於定義工具，這些工具可以以標準格式被 AI 模型使用。

🚀 快速開始

@cmmv/mcp 模塊為 CMMV 應用程序提供了模型上下文協議 (MCP)，實現了語言模型 (LLM) 與應用程序之間的標準化交互。以下將詳細介紹其安裝、配置、應用程序設置、工具處理器創建、客戶端使用等內容。

✨ 主要特性

• 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 應用程序。