shadcn-ui MCP Server

shadcn-ui MCP Server

site icon
2025.05.07 0
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 服务器,旨在帮助开发者和 AI 助手快速获取组件的详细信息和示例。

核心功能

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

适用场景

  • 开发者在开发过程中需要快速查阅 shadcn/ui 组件的文档和示例。
  • AI 助手需要访问 shadcn/ui 组件的结构化数据以提供更好的开发支持。

工具列表

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

常见问题解答

  • 调试困难:由于 MCP 服务器通过 stdio 进行通信,调试可能具有挑战性。推荐使用 MCP Inspector 进行调试。

使用教程

使用依赖

安装依赖:

npm install

安装教程

构建服务器:

npm run build

开发时自动重建:

npm run watch

调试方式

使用 MCP Inspector 进行调试:

npm run inspector

许可证

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