Cmmv Mcp

<p align="center"> <a href="https://cmmv.io/" target="blank"><img src="https://raw.githubusercontent.com/cmmvio/docs.cmmv.io/main/public/assets/logo_CMMV2_icon.png" width="300" alt="CMMV Logo" /></a> </p> <p align="center">Contract-Model-Model-View (CMMV) <br/> 使用合约构建可扩展和模块化的应用程序。</p> <p align="center"> <a href="https://www.npmjs.com/package/@cmmv/mcp"><img src="https://img.shields.io/npm/v/@cmmv/mcp.svg" alt="NPM Version" /></a> <a href="https://github.com/cmmvio/cmmv/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@cmmv/mcp.svg" alt="Package License" /></a> </p>

<p align="center"> <a href="https://cmmv.io">文档</a> • <a href="https://github.com/cmmvio/cmmv/issues">报告问题</a> </p>

描述

@cmmv/mcp 模块实现了 CMMV 应用程序的模型上下文协议 (MCP)，允许 LLM（大型语言模型）和您的应用程序之间的标准化交互。 MCP 提供了一个结构化的接口，用于以标准格式定义 AI 模型可使用的工具。

特性

• LLM 集成: 促进您的应用程序和语言模型之间的双向通信。
• 灵活的传输方式: 支持通过服务器发送事件 (SSE) 或标准 I/O 进行传输。
• 基于 API 装饰器: 使用像 @MCPTool 这样直观的装饰器来注册工具。
• 使用 Zod 进行验证: 使用 Zod 进行输入模式验证。
• 连接管理: 强大的实现，用于处理多个并发连接。

安装

通过 pnpm 安装 @cmmv/mcp：

$ pnpm add @cmmv/mcp

配置

在您的 .cmmv.config.cjs 中或使用 ConfigSchema 配置 MCP 模块：

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' or 'stdio'
    },
    jwtSecret: {
      type: 'string',
      required: true,
      default: 'your-secret-key',
    },
    pingInterval: {
      type: 'number',
      required: true,
      default: 30000,
    },
    connectionTimeout: {
      type: 'number',
      required: true,
      default: 300000,
    },
  },
};

设置应用程序

在您的主文件中，包含 MCPModule 并配置您的应用程序：

import { Application, Config } from '@cmmv/core';
import { DefaultAdapter, DefaultHTTPModule } from '@cmmv/http';
import { MCPModule } from '@cmmv/mcp';
import { MCPHandlers } from './mcp-handlers';

Application.create({
    httpAdapter: DefaultAdapter,
    modules: [MCPModule],
    providers: [MCPHandlers],
});

创建 MCP 工具处理程序

使用 @MCPTool 装饰器来注册 LLM 可调用的工具：

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

export class MCPHandlers {
    @MCPTool('greet', {
        name: z.string(),
        age: z.number(),
    })
    public async greet({ name, age }: { name: string; age: number }) {
        return {
            content: `Hello \${name}, you are \${age} years old`,
        };
    }
}

使用 MCP 客户端

MCP 客户端可以使用 SSE 端点连接到您的服务器：

curl -X POST http://localhost:8765/messages \\
  -H "Content-Type: application/json" \\
  -d '{"type":"tool_call","name":"greet","arguments":{"name":"John","age":30}}'

装饰器

@MCPTool(name: string, schema: Record<string, z.ZodSchema>)

将方法注册为具有名称和验证模式的 MCP 工具。

最佳实践

• 清晰地定义模式: 使用 Zod 模式来清晰地定义每个工具的参数。
• 提供有意义的响应: 为 LLM 返回结构化且有用的响应。
• 优雅地处理错误: 在您的处理程序中实现强大的错误处理。
• 安全第一: 考虑使用 JWT 用于公共端点。
• 性能: 使用超时并保持处理程序轻量且快速。