mcpField
S
shadcn-ui MCP Server

shadcn-ui MCP Server

本地服务
github.com/ymadd开发工具6081 周前更新

关于 shadcn-ui MCP Server

shadcn-ui MCP Server 是一个基于 TypeScript 的 MCP 服务,为 shadcn/ui 组件提供参考信息。它面向需要查询组件文档与示例的 AI 助手,数据来自官方文档站点和 GitHub 仓库并会进行缓存。

主要功能

  1. 01列出全部 shadcn/ui 组件
  2. 02查询组件详细信息
  3. 03获取组件用法示例
  4. 04按关键词搜索组件

适用场景

  1. 01让 AI 助手查找合适的 shadcn/ui 组件
  2. 02获取组件的安装说明与代码示例
  3. 03查看组件的 Props 与变体

MCP 相关

该项目是 MCP 服务,向 MCP 客户端暴露 list_shadcn_components、get_component_details、get_component_examples 和 search_components 四个工具。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"shadcn-ui": {
"command": "npx",
"args": [
"-y",
"shadcn-ui-mcp-server"
]
}
}
}
启动命令npx -y shadcn-ui-mcp-server

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
npmshadcn-ui-mcp-server

工具

4

收录的工具列表 · 更新于 3 周前

此工具无需参数。

详细介绍

shadcn-ui MCP 服务

用于查询 shadcn/ui 组件参考信息的 MCP 服务

这是一个基于 TypeScript 的 MCP 服务,提供 shadcn/ui 组件的参考信息。它实现了 Model Context Protocol(MCP)服务,帮助 AI 助手访问 shadcn/ui 组件文档和示例。

功能

工具
  • list_shadcn_components - 获取所有可用 shadcn/ui 组件的列表
  • get_component_details - 获取特定组件的详细信息
  • get_component_examples - 获取特定组件的用法示例
  • search_components - 按关键字搜索组件
功能说明

此服务会抓取并缓存以下来源的信息:

它提供的结构化数据包括:

  • 组件描述
  • 安装说明
  • 用法示例
  • 属性和变体
  • 代码示例

开发

安装依赖:

npm install

构建服务:

npm run build

在开发期间启用自动重新构建:

npm run watch

安装

Claude Desktop 配置

如需与 Claude Desktop 配合使用,请添加服务配置:

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

选项 1:使用本地构建
{
  "mcpServers": {
    "shadcn-ui-server": {
      "command": "/path/to/shadcn-ui-server/build/index.js"
    }
  }
}
选项 2:使用 npx 命令
{
  "mcpServers": {
    "shadcn-ui-server": {
      "command": "npx",
      "args": ["-y", "shadcn-ui-mcp-server"]
    }
  }
}
Windsurf 配置

将以下内容添加到 ./codeium/windsurf/model_config.json:

{
  "mcpServers": {
    "shadcn-ui-server": {
      "command": "npx",
      "args": ["-y", "shadcn-ui-mcp-server"]
    }
  }
}
Cursor 配置

将以下内容添加到 .cursor/mcp.json:

{
  "mcpServers": {
    "shadcn-ui-server": {
      "command": "npx",
      "args": ["-y", "shadcn-ui-mcp-server"]
    }
  }
}
调试

由于 MCP 服务通过 stdio 通信,调试可能颇具挑战。我们建议使用 MCP Inspector,它可通过包脚本运行:

npm run inspector

Inspector 会提供一个 URL,供你在浏览器中访问调试工具。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。