使用说明

• 项目简介
  • CodingBuddy MCP 服务器是一个基于 MCP（Model Context Protocol）的后端服务，负责向 LLM 客户端提供统一的上下文信息与功能。核心能力包括资源管理、工具注册与执行、以及 Prompt 模板的定义与渲染。服务器通过 JSON-RPC 与客户端通信，支持多种传输模式。
• 主要功能点
  • 资源管理：托管和提供项目配置、核心规则、代理人定义等资源，客户端可以读取和列出资源。
  • 工具注册与执行：注册多种工具，支持查询、获取代理人详情、解析模式、获取项目配置、以及给出配置更新建议等能力。
  • Prompt 模板：定义并渲染 prompts 与模板，便于通过控件化的模板快速生成合规的配置。
  • 会话与能力声明：服务器声明自身能力，管理连接与会话状态。
  • 多传输协议支持：实现基于 Stdio 的独立运行，以及通过 SSE/HTTP 的传输模式，便于在不同环境下部署。
• 安装步骤
  • 克隆仓库并进入项目根目录。
  • 安装依赖：使用 Yarn 作为包管理器，执行 yarn install。
  • 构建与运行：按照仓库提供的构建/启动流程进行打包与运行（通常为将应用编译为 dist 并通过 Node 启动主进程，或通过 CLI 启动 MCP 服务器）。
  • 启动方式：通过命令行启动 MCP 服务，例如使用 CLI 工具启动服务器（具体命令以项目提供的 CLI 为准）。
• 服务器配置（MCP 客户端所需配置示例，说明性描述，不包含实际代码） { "serverName": "codingbuddy", "startCommand": { "command": "npx", "args": ["codingbuddy", "mcp"] }, "transport": "stdio", "description": "启动 CodingBuddy 的 MCP 服务器，提供资源、工具与 Prompts 的 MCP 服务", "notes": "客户端仅需知道服务器的启动命令与传输方式，即可通过 MCP JSON-RPC 与服务器交互；无需额外代码。" }
• 基本使用方法
  • 准备工作：确保 MCP 服务器已安装依赖并可启动。
  • 启动服务器：按上面的启动命令启动服务（服务器启动后会监听并响应 MCP 客户端的请求）。
  • 客户端交互：客户端通过 JSON-RPC 发送请求（如 resources/list、tools/list、prompts/list 等），服务器返回相应的资源、工具信息或遍历结果。Prompts、配置与分析相关的请求也可被处理。
  • 维护与扩展：可通过修改规则、代理人、配置加载等模块来扩展 MCP 服务器的能力，并重新部署。