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