93.6k

MCP Server

PreviousNext

MCP support for registry developers

The shadcn MCP server works out of the box with any shadcn-compatible registry. You do not need to do anything special to enable MCP support for your registry.

See the MCP documentation for more information on how to use the shadcn MCP server.


Configuring MCP

Ask your registry consumers to configure your registry in their components.json file and install the shadcn MCP server:

Configure your registry in your components.json file:

components.json
{
  "registries": {
    "@acme": "https://acme.com/r/{name}.json"
  }
}

Run the following command in your project:

pnpm dlx shadcn@latest mcp init --client claude

Restart Claude Code and try the following prompts:

  • Show me all available components in the shadcn registry
  • Add the button, dialog and card components to my project
  • Create a contact form using components from the shadcn registry

Note: You can use /mcp command in Claude Code to debug the MCP server.


Best Practices

Here are some best practices for MCP-compatible registries:

  1. Clear Descriptions: Add concise, informative descriptions that help AI assistants understand what a registry item is for and how to use it.
  2. Proper Dependencies: List all dependencies accurately so MCP can install them automatically.
  3. Registry Dependencies: Use registryDependencies to indicate relationships between items.
  4. Consistent Naming: Use kebab-case for component names and maintain consistency across your registry.