DaisyUI MCP Server

使用说明(Markdown 格式)

项目简介

DaisyUI MCP Server 是一个基于 MCP 的服务器端实现,用于将 DaisyUI 组件的文档、资源和工具暴露给 LLM 客户端,支持通过 MCP 的工具调用和资源查询来实现对文档的查询和渲染。

主要功能点

  • 托管组件文档:从 components 目录读取 Markdown 文件,按组件名称提供详细文档。
  • 注册与执行工具:提供 list_components 和 get_component 两个工具,供客户端查询组件列表与获取详细文档。
  • 资源管理与索引:通过读取 Markdown 文件中的头部信息构建组件索引,方便快速查询和检索。
  • 动态组件扩展:可以通过 update_components.py 自动抓取外部文档并生成新的组件 Markdown 文件,自动更新索引。
  • 服务器实现与暴露接口:使用 FastMCP 库实现 MCP 接口,将命令、查询和文档以标准化的方式暴露给客户端。

安装步骤

  • 确保使用 Python 3.9 及以上版本。
  • 安装依赖(示例:pip install fastmcp)。
  • 克隆或下载本仓库到本地。
  • 准备组件文档:将 DaisyUI 组件文档整理成 components 目录下的 Markdown 文件,或运行 update_components.py 以自动抓取并生成 Markdown。
  • 启动服务器:在项目根目录执行 python mcp_server.py。
  • 浏览或通过 MCP 客户端连接:服务器启动后,客户端即可调用 list_components、get_component 等工具。

服务器配置

以下为 MCP 客户端连接服务器的配置信息(JSON 格式,供参考,实际客户端不需要直接部署代码): { "server_name": "DaisyUI MCP Server", "command": "python", "args": ["mcp_server.py"], "description": "启动 DaisyUI MCP Server,提供组件索引和组件详细文档的查询与加载服务" } 注释:

  • server_name: 服务器在 MCP 客户端中的显示名称。
  • command: 启动服务器的命令,例如 python。
  • args: 启动命令的参数,这里指向 mcp_server.py。
  • description: 对客户端的简要说明,方便在客户端侧识别与连接。

基本使用方法

  • 启动服务器后,使用 MCP 客户端调用 list_components 获取可用组件列表及简要描述。
  • 使用 get_component(name) 获取指定组件的详细文档(Markdown 格式的内容)。
  • 如需更新组件文档,请运行 update_components.py 以抓取 DaisyUI 文档并生成 /components 目录中的 Markdown 文件。
  • 组件文档的索引会在服务器启动时加载,确保 components 目录存在且有有效的 Markdown 文件。

服务器信息