CLEO MCP 服务器

使用说明(Markdown 格式)

  • 项目简介

    • CLEO MCP 服务器是 CLEO 平台的一部分,负责对接 LLM 客户端,通过统一的 JSON-RPC 协议提供资源访问、工具执行和提示渲染等能力,并实现会话管理、能力声明和多传输通道支持,确保在大模型驱动的应用中提供稳定、可控的上下文服务。
  • 主要功能点

    • 提供 MCP 合同下的核心端点和网关,支持查询(读)与变更(写)的分离,通过 JSON-RPC 进行请求/响应。
    • 资源与数据访问能力:托管与管理各类 Resources,为 LLM 提供数据来源。
    • 工具注册与执行:注册外部工具并暴露统一入口,LLM 客户端可通过工具调用外部功能。
    • Prompt 模板定义与渲染:提供可定制的 Prompt 模板,支撑不同交互模式。
    • 会话管理与生命周期:会话创建、维护、归档与审计日志,确保对话上下文可追溯。
    • 能力声明与扩展性:支持各种工具、域和推理能力的声明与扩展。
    • 安全与合规:4 层校验机制(模式、语义、引用、协议)确保写操作安全、具可预测性;并具备预算管控、缓存和背景任务管理等保障。
  • 安装步骤

    • 确保环境具备 Node.js(及 npm / pnpm)等基础运行环境。
    • 在仓库根目录执行依赖安装:安装完毕后通常需要编译/构建以生成可运行的服务文件(具体命令可参考项目的 package.json 脚本,通常为 npm install 与后续构建/启动步骤)。
    • 启动 MCP 服务器:根据仓库的设计,通常通过 CLI 或 npx 直接启动 MCP 服务,服务器会监听并通过标准输入/输出等传输通道接收 MCP 客户端请求。
    • 启动后,客户端即可通过 MCP 的 JSON-RPC 风格调用读取资源、执行工具、获取 Prompts 等能力。
  • 服务器配置(MCP 客户端需要知道的连接信息) 配置示例(JSON,说明性文本,不作为可执行代码): { "server": "cleo", "command": "npx", "args": ["-y", "@cleocode/cleo", "--mcp-server"] } 注释:

    • server: 服务器注册名称,便于工具发现与管理。
    • command: 启动 MCP 服务器的可执行命令,通常为 npx 或本地全局安装的 cleo 命令。
    • args: 启动参数列表,示例中使用的 "--mcp-server" 表示以 MCP 服务器模式启动。 说明:MCP 客户端配置仅用于注册与连接信息,实际交互仍通过 JSON-RPC 调用进行。不同环境可根据实际部署调整 command 与 args。
  • 基本使用方法

    • 客户端与服务端对接:客户端发起 MCP 请求(如读取资源、调用工具、获取 Prompt),MCP 服务器返回标准的 JSON-RPC 响应或通知。
    • 资源与工具操作:通过两类工具入口(read-only 的查询工具与写操作的变更工具)进行数据访问和写入。
    • 会话与上下文:服务器负责会话管理和上下文数据的持久化,确保跨请求的一致性与可追溯性。
    • 安全与扩展:4 层验证、预算控制、缓存、后台任务等机制,保证高并发下的稳定性与安全性。

服务器信息