项目简介
本项目是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 提供 Ant Design 组件库的文档和相关信息。通过此服务器,LLM 可以理解和利用 Ant Design 组件,从而更好地辅助前端开发任务。
主要功能点
- 组件文档查询: 提供 Ant Design 组件的详细文档,包括 API、属性、使用方法等。
- 代码示例: 提供组件的使用示例代码,帮助 LLM 理解组件的具体用法。
- 更新日志: 提供组件的更新日志,方便 LLM 了解组件的版本变化。
- 组件列表: 列出所有可用的 Ant Design 组件。
- 预处理数据: 内置预处理的 Ant Design 组件数据,开箱即用。
- 数据更新: 支持用户自行提取最新或指定版本的 Ant Design 组件文档。
- 缓存机制: 采用缓存机制,减少 IO 压力,提高响应速度。
- Prompt 优化: 预配置 Prompt,优化 LLM 的工具调用效率。
安装步骤
-
安装 Node.js 和 npm: 确保你的开发环境已安装 Node.js 和 npm。
-
全局安装: 可以通过 npm 全局安装 '@jzone-mcp/antd-components-mcp' 包:
npm install -g @jzone-mcp/antd-components-mcp或者使用 npx 直接运行:
npx @jzone-mcp/antd-components-mcp
服务器配置
MCP 客户端需要配置以下 JSON 信息以连接到 Ant Design 组件 MCP 服务器。以下是 Claude Desktop 的配置示例,其他 MCP 客户端配置方式类似:
{ "mcpServers": { "Ant Design Components": { // 服务器名称,自定义 "command": "npx", // 启动服务器的命令,这里使用 npx "args": ["@jzone-mcp/antd-components-mcp"] // 命令参数,指定启动 @jzone-mcp/antd-components-mcp 包 } } }
- 'command': 启动服务器的命令,通常为 'npx' 或 'node'。
- 'args': 命令参数,对于全局安装的包,通常为包名 '@jzone-mcp/antd-components-mcp'。如果本地运行,则指向 'cli.js' 文件路径。
基本使用方法
配置完成后,在 MCP 客户端中选择 "Ant Design Components" 服务器。即可通过自然语言与 LLM 交互,查询 Ant Design 组件的相关信息。
示例查询:
有哪些 Ant Design 组件可用? 显示 Button 组件的文档。 Button 组件有哪些属性? 显示 Button 组件的代码示例。 查看 Button 组件的更新日志。
信息
分类
开发者工具