Sage Design Engine MCP 服务器

关键词

组件查询组件注册表JSON-RPCLLM 集成应用模板

使用说明（Markdown格式）

  • 项目简介

    • 该仓库实现了一个基于 Model Context Protocol（MCP）的服务端，用于向 LLM 客户端提供对 Sage Design Engine 组件库的上下文信息、数据访问能力、工具执行能力以及应用模板/示例的获取等能力。服务器通过标准的 JSON-RPC 请求/响应进行通信，支持通过标准传输（如 STDIO）与客户端对接。

  • 主要功能点

    • MCP 核心能力：实现工具注册与执行、组件查询、安装指引、应用壳模板获取、组件示例等 MCP 工具。
    • 服务器实现：包含实际可运行的 MCP 服务代码，使用 @modelcontextprotocol/sdk 提供的 Server、StdioServerTransport 等组件建立和管理 JSON-RPC 交互。
    • 组件注册与查询：内置组件注册表，可按分类检索组件、获取组件详情（描述、props、示例、用例、依赖等）。
    • 生成与输出：支持输出格式化的组件列表、组件详情文本，以及安装指引文本等，便于直接传递给 LLM/开发者。
    • Eject/代码获取支持：提供将组件源码转换为可在本地项目中直接使用的“转储”输出，方便 AI 助手在代码维度进行修改与集成。
    • 多工具入口：list_components、search_components、get_component、install_component、get_app_shell、get_examples、get_audit_checklist、eject_component 等工具。

  • 安装与运行步骤

    • 运行环境要求：Node.js 环境，支持执行 MCP 服务器。
    • 启动方式（任选其一）：
      • 直接通过 MCP 提供的 CLI/入口运行（在具备 npm/yarn/pnpm 的环境中执行）：
        • 使用命令 npx @thesage/mcp 启动，服务将以标准输入输出（stdio）传输与客户端通信。
      • 将服务器源码编译/执行：将该仓库中的 MCP 服务源码编译为可执行的 JS/TS 产物后运行，具体入口为 mcp 目录中的启动脚本，带有 #!/usr/bin/env node 的 shebang 行，直接执行也可。
    • 运行前准备：确保依赖已安装，仓库根目录环境准备就緒后执行启动命令即可。由于 MCP 客户端通常以 JSON-RPC 形式与服务器交互，确保客户端配置正确指向该服务器。

  • 服务器配置（MCP 客户端需要的配置信息，JSON 格式）

    • serverName: sds-mcp-server
    • command: npx
    • args: ["@thesage/mcp"]
    • 注释：上述配置用于客户端在连接 MCP 服务器时指定启动该 MCP 服务器的命令及参数。该配置并非客户端必需的代码，而是描述性的连接信息，便于理解与集成。

  • 基本使用方法

    • 连接与调用：客户端通过 MCP 协议向服务器发送 JSON-RPC 请求，调用如 list_components、search_components、get_component、install_component、get_app_shell、get_examples、get_audit_checklist、eject_component 等工具，服务器返回相应的 JSON-RPC 响应文本或带有 content 的文本块。
    • 常见用例：
      • 列出所有组件：请求 tool list_components；可按分类筛选。
      • 搜索组件：请求 tool search_components，传入 query 字段，获取匹配的组件信息。
      • 获取组件详情：请求 tool get_component，传入 name 字段，获取组件完整信息（描述、props、用例、依赖等）。
      • 获取应用壳与示例：请求 tool get_app_shell 或 get_examples，获取完整的应用骨架或组件用法示例。
      • 代码转储/导出：请求 tool eject_component，传入 component 名称，获得可直接在本地项目中使用的转储文本及依赖提示。

服务器信息

访问项目