使用说明

  • 项目简介

    • 该仓库实现了一个基于 MCP 的服务器端,能够向 LLM 客户端提供 Clarity 相关的上下文资源、工具调用(如获取上下文、生成 Clarity 代码)以及与后端 RAG/嵌入检索的整合能力。通过 MCP 协议,LLM 客户端可以请求获取上下文、执行工具、以及生成代码等功能,并获得结构化的 JSON-RPC 风格响应。
  • 主要功能点

    • 提供两个核心 MCP 工具:
      • get_clarity_context:从后端 RAG 服务检索与 Clarity 相关的代码片段与文档上下文
      • generate_clarity_code:基于检索到的上下文,调用后端 RAG 及代码生成提供者生成 Clarity 代码
    • 与后端 REST API 集成,使用 API Key 验证,支持后端地址配置
    • 通过 stdio 传输实现 MCP 服务器通信(MCP 客户端可通过 Cursor 等编辑器对接)
    • 会话与请求日志支持,便于分析使用情况与性能
    • 与后端数据存储、向量检索(ChromaDB)以及多 Provider(Gemini/OpenAI/Claude)协作
  • 安装步骤

    • 在本地搭建需要的运行环境(Node.js 及相关依赖)并安装依赖
    • 构建并启动 MCP 服务器:使用仓库提供的 mcp_server 入口,确保后端服务可用
    • 配置 MCP 客户端连接信息(参见下方“服务器配置”示例)
  • 服务器配置(MCP 客户端需要的最小配置信息)

    • JSON 形式示例(请将其中的占位信息替换为实际值,且其中的 KEY 及 BACKEND_URL 根据你的环境配置) { "mcpServers": { "stacks-builder": { "command": "node", "args": ["/absolute/path/to/stacks-builder/mcp_server/dist/index.js"], "env": { "API_KEY": "<你的_api_key>", "BACKEND_URL": "http://localhost:8080" } } } } 注释说明:
    • name: stacks-builder 为 MCP 服务的名称,与服务对接时的一致
    • command: 启动 MCP 服务器的命令
    • args: 携带的启动参数(如果需要构建输出,请指向构建产物的位置)
    • env: 环境变量,包含用于后端鉴权的 API_KEY 与后端服务地址 BACKEND_URL
    • MCP 客户端不需要实现服务器端逻辑,仅需要按以上字段提供启动命令与参数,即可与 MCP 服务器建立连接
  • 基本使用方法

    1. 启动后端服务(后端 API、RAG、ChromaDB 等应就绪)
    2. 在 MCP 客户端配置中添加 stacks-builder 的 MCP 服务器配置
    3. 通过 MCP 客户端对 stacks-builder 发起以下操作:
      • get_clarity_context:检索 Clarity 上下文
      • generate_clarity_code:基于上下文生成 Clarity 代码
    4. 根据 MCP 客户端输出,处理来自 MCP 服务器的文本/代码片段与解释
    5. 如需开发调试,可在后端日志中查看请求/响应与 token 数等指标
  • 额外要点

    • MCP 服务器端采用 StdIO 传输,可扩展为 SSE/WebSocket 等传输方式
    • 服务器具备会话管理、能力声明等能力,便于在多模态交互场景中协同工作

信息

分类

AI与计算