使用说明

• 项目简介 Composter MCP 服务器是一个后端服务，负责以标准化的 MCP 形式向大型语言模型（LLM）客户端提供组件库的上下文信息、数据访问能力及外部功能调用能力。它通过 JSON-RPC 风格的 MCP 协议与客户端通信，提供对资源的读取、工具执行以及提示模板的能力，并可通过标准的传输方式（本实现使用标准输入输出的 MCP 传输）来服务多种 AI 助手。

• 主要功能点

  • MCP 核心能力: 提供对资源（分类、组件）的查询、读取组件源码、以及基于关键字的组件搜索等能力，全部通过 MCP 工具对外暴露。
  • 工具集成: 通过预定义的工具（如 list_categories、list_components、read_component、search_components）实现对后端数据的访问与操作，支持自然语言查询路由。
  • 与后端数据源对接: 服务器从现有后端 API (/api) 获取组件、分类等数据，并对外提供一致的 MCP 接口。
  • 会话与认证: 依赖现有的 CLI session 机制，确保在启动 MCP 服务前完成认证。
  • 传输与扩展性: 当前实现使用 StdioTransport（标准输入/输出）作为 MCP 的传输通道，亦可在需要时扩展为 SSE、WebSocket 等传输模式。

• 安装步骤

  • 准备工作: 确保已经部署并可访问后端 API（如本仓库的 API 服务）。
  • 安装 MCP 服务依赖：进入仓库中的 mcp 包目录，安装依赖。
  • 启动后端 API 服务（如尚未运行时）：参考仓库根部的快速启动说明，先启动 apps/api。
  • 启动 MCP 服务器：在仓库根目录或相应工作区执行启动命令，使 MCP 服务器通过标准输入输出与客户端对接。

• 服务器配置（供 MCP 客户端使用的配置示例） 说明：以下为 MCP 客户端需要的配置 JSON，其中包含服务器名称、启动命令以及参数等信息，用于将 Composter 作为一个 MCP 服务器接入到 AI 助手的工作流中。服务器名称用于标识该 MCP 服务，command 与 args 指定如何启动 MCP 服务器进程。注意：MCP 客户端本身不需要将此配置视为代码执行，仅用于建立连接信息。 配置示例（JSON 格式，不作为代码块展示）： { "serverName": "Composter", "mcpServers": { "composter": { "name": "Composter", "command": "npx", "args": ["composter-mcp"] } } } 说明：

  • serverName: MCP 客户端在 UI 中显示的服务器名称，建议设为 "Composter"。
  • command: 启动 MCP 服务器的命令，当前实现通过 Node.js/PNPM 脚本启动工具，使用 npx 启动 composter-mcp。
  • args: 启动命令的参数，通常为 ["composter-mcp"]，用于执行 MCP 服务入口。
  • 以上信息来自仓库中的入口脚本与初始化逻辑，确保与实际部署一致性。

• 基本使用方法

  • 在 AI 助手中配置：将 Composter 的 MCP 服务添加到工具列表中，使用上面的配置示例启动和连接。
  • 启动与连接流程：启动 MCP 服务后，LLM 客户端通过 MCP 的 JSON-RPC 接口向服务器发送请求，服务器依据请求执行相应的工具并返回结果。
  • 常见交互场景：如“列出所有分类”、“列出某分类的组件”、“读取某组件源码”、“按关键字查找组件”等。

• 额外提示

  • 为确保正常工作，请先确保本地或远程后端 API 已就绪并可访问，以及你已通过 CLI 完成用户登录以获取有效会话。
  • 若需要扩展传输方式，可参照 MCP 标准扩展为 SSE、WebSocket 等传输通道。