使用说明(Markdown格式)

  • 项目简介

    • CCW 的 MCP 服务器实现,提供标准化的资源、工具、Prompts 的托管、注册和执行能力,并通过 JSON-RPC 与客户端通信,作为 LLM 应用的上下文服务后端。
  • 主要功能点

    • 资源管理:托管和访问资源及上下文数据,方便 LLM 客户端获取所需上下文。
    • 工具注册与执行:注册外部工具并支持客户端调用外部功能。
    • Prompt 定义与渲染:定义与渲染用于 LLM 交互的 Prompt 模板,支持可定制的交互模式。
    • JSON-RPC 通信:服务器接收 JSON-RPC 请求,返回 JSON-RPC 响应,便于 LLM 客户端易于解析。
    • 会话/能力声明:支持会话管理、能力声明等 MCP 服务器核心能力。
    • 多传输协议扩展:目标架构设计支持多种传输协议,当前实现以 MCP 服务器为核心,便于未来扩展到 Stdio、SSE、WebSocket 等传输。
  • 安装步骤

    • 需要 Node.js 环境(推荐版本与仓库要求保持一致)。
    • 安装依赖并构建/准备运行环境(按照仓库中现有的构建与启动流程执行,比如 npm/yarn 安装、构建 dist、准备启动脚本等)。
  • 服务器配置(MCP 客户端端口/连接方式的描述)

    • 服务器名称(server_name):Claude Code Workflow MCP 服务器
    • 启动命令(command):node
    • 启动参数(args):["ccw/bin/ccw-mcp.js"]
    • 说明:启动后服务器通过标准输入输出进行 JSON-RPC 通信。该 MCP 服务器实现已在仓库中提供可执行入口,测试用例通过将 JSON-RPC 请求写入服务器进程的标准输入并从标准输出接收响应来进行验证。
    • 备注:MCP 客户端通常需要通过该配置知道如何启动服务器以及与之建立连接的方式(在本实现中,最直接的连接方式是 STDIO JSON-RPC)。
  • 基本使用方法

    • 步骤1:启动服务器
      • 运行启动命令,监听输入输出通道,准备接收 JSON-RPC 请求。
    • 步骤2:发送 MCP 请求
      • 以 JSON-RPC 2.0 的格式向服务器发送请求,例如读取资源、调用工具、获取 Prompt 等。
    • 步骤3:解析响应
      • 服务器返回标准的 JSON-RPC 响应,包含 result 或 error 字段,客户端可基于响应进行后续处理。
    • 步骤4:会话与能力管理
      • 根据需要声明和查询服务器能力,进行会话管理和资源/工具的状态管理。
  • 注意事项

    • 当前实现侧重在 MCP 服务器入口与集成测试的支持,实际运行时请确保 dist/mcp-server/index.js 已正确编译并可通过 ccw-mcp.js 入口启动。
    • 如需客户端与服务器的扩展对接,请参考仓库中对应的测试用例,了解常用请求格式及响应结构。

信息

分类

开发者工具