thesvg MCP服务器

使用说明内容(Markdown格式)

  • 项目简介 该项目实现了一个 MCP 服务器,作为 thesvg 的后端服务,提供对图标资源的查询与获取、工具执行,以及分类信息的获取等能力,旨在为大语言模型客户端提供结构化的上下文与功能入口。

  • 主要功能点

    • 提供对图标资源的检索与详情获取,支持按名称、Slug、分类等条件查询。
    • 支持获取单个图标的详细数据以及可用变体信息(如 default、monochrome、wordpress 等变体)。
    • 提供用于图标相关的工具接口,例如搜索图标、获取图标、获取图标URL、列出分类等,用以在对话中动态获取资源。
    • 通过 MCP 的 JSON-RPC 形式与客户端通讯,具备会话管理与能力声明能力。
    • 目前实现通过标准输入输出(stdio)传输,后续可扩展为 SSE、WebSocket 等传输模式。
  • 安装步骤

    • 获取代码:将仓库克隆到本地环境。
    • 安装依赖:确保 Node.js 环境可用后,在对应包目录安装依赖。
    • 运行服务:在具备 TypeScript/Node 运行环境的条件下,按照环境选择合适的执行方式(如使用 tsx/npx 脚本运行 index.ts),启动 MCP 服务器。
  • 服务器配置(MCP 客户端需要的启动信息) 下面给出 MCP 客户端配置示例(JSON 格式,描述服务器名称、启动命令及参数等,便于 MCP 客户端在连接时读取): { "server": "thesvg", "command": "npx", "args": ["tsx", "packages/mcp/src/index.ts"], "transport": "stdio", "version": "0.1.0", "description": "MCP 服务器实现,提供 thesvg 的资源、工具与提示模板能力。" } 注释说明:

    • server 字段标识服务器名称,与 MCP 客户端进行对照。
    • command 为启动命令,args 为启动参数,组合起来应能在支持 TypeScript 的环境中启动服务器。
    • transport 指定通信传输方式,此实现使用 stdio,后续可扩展为 SSE/WebSocket。
    • version 与 description 为可选元信息,便于客户端对服务器能力的描述与版本管理。
  • 基本使用方法

    • 启动服务器后,MCP 客户端通过规定的传输通道连接,向服务器发送 JSON-RPC 格式的请求来查询资源、执行工具、获取 Prompts 等。
    • 客户端可通过以下工具进一步交互:search_icons、get_icon、get_icon_url、list_categories 等,服务器返回相应的 JSON-RPC 响应或文本通知。
    • 如需扩展,请在服务器端添加新的工具或资源端点,并确保遵循 MCP 的请求/响应格式。

服务器信息