Shadcn Registry Manager

🚀 shadcn registry manager - MCP Server

This project offers an MCP (Model Context Protocol) server for the shadcn/ui component registry and CLI. It allows for remote, programmatic, or containerized execution of shadcn CLI commands, facilitating automation, integration, and execution in cloud or development environments.

🚀 Quick Start

This MCP server exposes shadcn CLI operations as MCP tools, enabling you (or an AI agent) to perform various tasks such as initializing a project, adding components from the shadcn registry, listing and fetching registry items, and running all shadcn CLI workflows remotely.

✨ Features

• Initialize a project.
• Add components from the shadcn registry, including block components.
• List and fetch registry items.
• Run all shadcn CLI workflows remotely.
• Support both the official shadcn registry - https://ui.shadcn.com/r and custom/self - hosted registries (follow this guide: https://ui.shadcn.com/docs/blocks).

📦 Installation

Docker

Run the MCP server in a container, mounting your project directory. Add the following to your mcp.json file:

   "shadcn-registry-manager": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--mount",
        "type=bind,src=<your-project-path>,dst=/workspace",
        "-e", 
        "REGISTRY_URL=https://ui.shadcn.com/r",
        "-e", 
        "STYLE=new-york",
        "reuvenaor/shadcn-registry-manager"
      ],
    },

Docker mounting explanation:

• <your-project-path>: The path to your project directory. Example: /Library/Projects/shadcn-registry-manager/www.
• /workspace: The path to the workspace directory inside the container. (Don't change it. If you do, you must pass the same path as the cwd param on every tool call.)

Docker ENV Variables:

• REGISTRY_URL:
  • Option 1: https://ui.shadcn.com/r - The URL of the shadcn registry.
  • Option 2: http://localhost:3000>/r - The URL of your own registry server (follow this guide: https://ui.shadcn.com/docs/blocks).
• STYLE: The style of the shadcn registry - new-york.

npx

You can also run the MCP server using npx, which is convenient for local development or CI/CD pipelines. Add the following to your mcp.json file:

  "shadcn-registry-manager": {
    "command": "npx",
    "args": [
      "@reuvenorg/shadcn-registry-manager"
    ],
    "env": {
      "REGISTRY_URL": "https://ui.shadcn.com/r",
      "WORKSPACE_DIR": "/Library/Projects/mcp-docker/www",
      "STYLE": "new-york"
    }
  }

Claude

You can also use the MCP server with Claude. Here are the configuration options:

Claude CLI Command:

claude mcp add --scope project shadcn-registry-manager npx @reuvenorg/shadcn-registry-manager -e REGISTRY_URL=https://ui.shadcn.com/r -e WORKSPACE_DIR=/Library/Projects/resume -e STYLE=new-york

Claude .mcp.json Configuration:

{
  "shadcn-registry-manager": {
    "type": "stdio",
    "command": "npx",
    "args": [
      "@reuvenorg/shadcn-registry-manager"
    ],
    "env": {
      "REGISTRY_URL": "https://ui.shadcn.com/r",
      "WORKSPACE_DIR": "/Library/Projects/resume",
      "STYLE": "new-york"
    }
  }
}

npx ENV Variables:

• WORKSPACE_DIR: The path to your project directory (mounted as the workspace).
• REGISTRY_URL:
  • Option 1: https://ui.shadcn.com/r - The URL of the shadcn registry.
  • Option 2: http://localhost:3000/r - The URL of your own registry server (follow this guide: https://ui.shadcn.com/docs/blocks).
• STYLE: The style of the shadcn registry - new-york.

💻 Usage Examples

Basic Usage

Here are some example MCP tools and how to use them:

• get_init_instructions: Get project initialization instructions.
• execute_init: Run full project initialization.
• get_items: List available registry items.
• get_item: Fetch a specific registry item.
• add_item: Add a registry item to your project.
• execute_add: Add multiple components to your project.
• get_blocks: Get current blocks from the registry.

Advanced Usage

use the tool `get_blocks` to get the blocks from the registry

use the tool `add_item` - dashboard-01 to your project

📚 Documentation

• Source:
  • shadcn/ui
  • Model Context Protocol

made with ❤️ by Reuven Naor

📄 License

MIT License. See LICENSE for details.