项目简介: 本仓库实现了一个MCP服务器,旨在为大型语言模型(LLM)客户端提供关于 shadcn/ui 组件库的详细信息。通过集成此服务器,LLM 能够便捷地查询和获取 shadcn/ui 组件的各类信息,例如组件描述、使用示例和属性等,从而有效辅助 LLM 在前端开发任务中更好地利用 shadcn/ui 组件库。
主要功能点:
- 组件列表查询: 允许 LLM 获取 shadcn/ui 组件库中所有可用组件的清单。
- 组件详情获取: 针对特定组件,提供包括描述、安装指南、使用示例、属性等在内的详细信息。
- 组件搜索: 支持通过关键词搜索 shadcn/ui 组件,快速定位所需组件。
- 使用示例: 提供组件的使用代码示例,帮助理解和应用组件。
安装步骤:
- 确保您的开发环境中已安装 Node.js 和 npm (或 yarn)。
- 将本仓库克隆到您的本地计算机。
- 在仓库根目录下,打开终端并执行命令 'npm install' 或 'yarn install',安装项目依赖。
- 执行命令 'npm run build' 或 'yarn build' 构建服务器代码,生成可执行文件。
服务器配置: 要将此 MCP 服务器与支持 MCP 协议的 LLM 客户端(如 Claude Desktop)配合使用,您需要在客户端中添加服务器配置。以下是配置示例 JSON 代码,请根据您的实际安装路径调整 'command' 字段:
{ "mcpServers": { "shadcn-ui-server": { "command": "/path/to/shadcn-ui-server/build/index.js" } } }
- 'shadcn-ui-server': 您为该服务器自定义的名称,用于在 LLM 客户端配置中识别和引用此服务器。
- 'command': 服务器启动命令,指向服务器编译后的入口文件 'index.js'。请将 '/path/to/shadcn-ui-server/build/index.js' 替换为 'shadcn-ui-server/build/index.js' 文件在您本地文件系统中的绝对路径。
基本使用方法:
- 完成上述配置后,当 LLM 客户端启动并尝试使用 MCP 功能时,将自动连接到此服务器。无需手动启动服务器,配置中的 'command' 命令会在客户端需要时被调用。
- 在 LLM 客户端中,您可以通过工具调用请求服务器提供的功能。例如,在需要 shadcn/ui 组件信息时,客户端可以调用以下工具:
- 'list_shadcn_components': 获取所有 shadcn/ui 组件的列表。
- 'get_component_details': 获取指定组件的详细信息。使用时需要提供 'componentName' 参数,例如 '{"componentName": "button"}'。
- 'search_components': 根据关键词搜索组件。使用时需要提供 'query' 参数,例如 '{"query": "form"}'。
- 'get_component_examples': 获取指定组件的使用示例。使用时需要提供 'componentName' 参数,例如 '{"componentName": "accordion"}'。
信息
分类
开发者工具