组件
shadcn MCP 服务器 可与任何 shadcn 兼容的注册表即时工作。您无需执行任何特殊操作即可为您的注册表启用 MCP 支持。
先决条件
MCP 服务器通过请求您的注册表索引来工作。请确保您的注册表根目录中有一个名为 registry
的注册表项文件。
例如,如果您的注册表托管在 https://acme.com/r/[name].json
,则您应该在 https://acme.com/r/registry.json
或 https://acme.com/r/registry
处有一个文件(如果您使用的是 JSON 文件扩展名)。
此文件必须是符合 注册表模式 的有效 JSON 文件。
配置 MCP
请您的注册表消费者在他们的 components.json
文件中配置您的注册表并安装 shadcn MCP 服务器。
在您的 components.json
文件中配置您的注册表
{
"registries": {
"@acme": "https://acme.com/r/{name}.json"
}
}
在您的项目中运行以下命令
pnpm dlx shadcn@latest mcp init --client claude
重新启动 Claude 代码 并尝试以下提示
- 向我展示 acme 注册表中的组件
- 使用 acme 注册表中的项目创建登录页面
注意:您可以在 Claude 代码中使用 /mcp
命令来调试 MCP 服务器。
您可以在 MCP 文档 中阅读有关 MCP 服务器的更多信息。
最佳实践
以下是 MCP 兼容注册表的一些最佳实践
- 清晰的描述:添加简洁、信息丰富的描述,帮助 AI 助手了解注册表项的用途以及如何使用它。
- 正确的依赖项:准确列出所有
dependencies
,以便 MCP 可以自动安装它们。 - 注册表依赖项:使用
registryDependencies
来指示项目之间的关系。 - 一致的命名:对组件名称使用 kebab-case 并保持注册表的一致性。