使用说明(Markdown 格式)
– 项目简介
- 该仓库的 ai/mcp-server 子模块实现了一个基于 Model Context Protocol(MCP)的服务器端。它通过 MCP SDK 提供资源读取、工具调用等能力,供客户端(如 LLM 编辑器或自动化代理)按统一协议访问资源、执行外部工具,以及获取/渲染提示模板内容。
– 主要功能点
- 资源管理:向客户端暴露设计系统的 Tokens(颜色、排版、间距等)等设计资源的读取接口。
- 工具注册与执行:注册并实现了工具集合(如获取组件提示、获取平台上下文等),通过 CallTool 请求被客户端调用并返回结果。
- 提供并渲染提示:内置针对不同平台与组件的规则提示,支持在不同平台的上下文中拼装完整的指令集给 LLM 使用。
- JSON-RPC 通信:实现标准的 MCP 请求/响应流程,客户端通过 JSON-RPC 与服务器交互。
- 输入传输方式:当前实现使用 Stdio(标准输入/输出)传输,便于直接在命令行或管道中运行与对接。
– 安装与运行步骤
- 环境要求:Node.js(推荐 v18+,支持 ES 模块)、npm/yarn/pnpm 等包管理工具。
- 安装依赖并构建/准备运行环境(仓库根目录执行即可,具体命令请参考项目 README 的运行示例):
- 安装依赖:npm install
- 启动 MCP 服务器(典型用法,与仓库文档一致): npx @astrofusion/design-mcp-server start
- 说明:仓库中的 MCP 服务器实现位于 ai/mcp-server 目录,启动命令和运行方式与文档中的示例一致,服务器通过标准输入/输出与客户端对接。
– 服务器配置(MCP 客户端连接所需信息) 以下为一个文本描述的配置示例(JSON 格式,非代码块,供客户端了解如何连接服务器;实际使用时请以客户端读取的 JSON 配置为准): { "serverName": "astrofusion-design-system", "command": "npx", "args": ["@astrofusion/design-mcp-server", "start"] } 字段说明:
- serverName: MCP 服务器对外标识名称,供客户端辨识使用。对应仓库 README 中的启动示例中的服务名称。
- command: 启动服务器所执行的命令。示例中使用 npx。
- args: 启动命令的参数列表。示例中包含启动子命令 "start"。 注:MCP 客户端无需包含其他敏感信息,该配置仅用于描述如何启动并连接到 MCP 服务器。
– 基本使用方法
- 启动服务器 在仓库根目录执行:npx @astrofusion/design-mcp-server start 服务将通过标准输入/输出对接客户端,提供资源、工具和提示内容。
- 客户端交互
使用支持 MCP 的客户端应用(如 LLM 编辑器)连接该服务器,通过 JSON-RPC 形式请求以下能力:
- 读取资源:读取设计系统的颜色、排版、间距等 Tokens。
- 调用工具:获取组件/平台相关的系统提示、上下文等内容。
- 获取并渲染 Prompts:按平台/组件组合生成完整的提示文本以引导模型。
- 验证功能 客户端向 MCP 服务器发送请求,服务器应返回符合结构的 JSON-RPC 响应,或按需发送通知。
– 备注
- 当前实现以 Stdio 传输为核心通信方式,未来可扩展为 SSE/WebSocket 等传输协议以支持更多环境。
- MCP 服务端侧的资源、工具、提示内容均取自仓库内设计 tokens 与提示系统的实现,确保与设计系统的一致性。
信息
分类
AI与计算