shadcn-ui MCP Server

shadcn-ui MCP Server

site icon
2025.04.14 21
JavaScript组件管理开发工具开发效率
shadcn-ui-mcp-server 是一个基于 TypeScript 的 MCP 服务器,主要用于提供 shadcn/ui 组件的参考信息。它实现了模型上下文协议(MCP),帮助 AI 助手访问 shadcn/ui 组件的文档和示例。该服务器从官方 shadcn/ui 文档站点和 GitHub 仓库中抓取并缓存信息,提供结构化的数据,包括组件描述、安装说明、使用示例、属性和变体以及代码示例。
View on GitHub

Overview

基本能力

产品定位

shadcn-ui-mcp-server 是一个为 shadcn/ui 组件提供参考信息的 MCP 服务器,主要用于开发效率和组件管理。

核心功能

  • 获取所有可用的 shadcn/ui 组件列表
  • 获取特定组件的详细信息
  • 获取特定组件的使用示例
  • 通过关键词搜索组件

适用场景

  • 开发者在开发过程中需要快速查找 shadcn/ui 组件的文档和示例
  • AI 助手需要访问 shadcn/ui 组件的结构化数据
  • 团队协作开发时,统一组件参考信息

工具列表

  • list_shadcn_components - 获取所有可用的 shadcn/ui 组件列表
  • get_component_details - 获取特定组件的详细信息
  • get_component_examples - 获取特定组件的使用示例
  • search_components - 通过关键词搜索组件

常见问题解答

  • 调试 MCP 服务器可能具有挑战性,建议使用 MCP Inspector 进行调试。

使用教程

使用依赖

安装依赖:

npm install

安装教程

构建服务器:

npm run build

开发时自动重建:

npm run watch

在 Claude Desktop 中添加服务器配置:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "shadcn-ui-server": {
      "command": "/path/to/shadcn-ui-server/build/index.js"
    }
  }
}

调试方式

使用 MCP Inspector 进行调试:

npm run inspector

Inspector 将提供一个 URL,用于在浏览器中访问调试工具。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。