shadcn-ui-mcp-server
A mcp server to allow LLMS gain context about shadcn ui component structure,usage and installation,compaitable with react,svelte 5,vue & React Native
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/jpisnice--shadcn-ui-mcp-server)HTML
<a href="/listings/jpisnice--shadcn-ui-mcp-server"><img src="/api/listings/jpisnice--shadcn-ui-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
# Basic usage (60 requests/hour) npx @jpisnice/shadcn-ui-mcp-server # With GitHub token (5000 requests/hour) - Recommended npx @jpisnice/shadcn-ui-mcp-server --github-api-key ghp_your_token_here # Switch frameworks npx @jpisnice/shadcn-ui-mcp-server --framework svelte npx @jpisnice/shadcn-ui-mcp-server --framework vue npx @jpisnice/shadcn-ui-mcp-server --framework react-native # Use Base UI instead of Radix (React only) npx @jpisnice/shadcn-ui-mcp-server --ui-library base
**π― Get your GitHub token in 2 minutes**: [docs/getting-started/github-token.md](docs/getting-started/github-token.md)
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md Β· README Β· 306 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- # Shadcn UI v4 MCP Server
- [](https://badge.fury.io/js/@jpisnice%2Fshadcn-ui-mcp-server)
- [](https://opensource.org/licenses/MIT)
- [](https://modelcontextprotocol.io/specification/2026-07-28)
- [](https://archestra.ai/mcp-catalog/jpisnice__shadcn-ui-mcp-server)
- > **π The fastest way to integrate shadcn/ui components into your AI workflow**
- A Model Context Protocol (MCP) server that provides AI assistants with comprehensive access to [shadcn/ui v4](https://ui.shadcn.com/) components, blocks, demos, and metadata. Seamlessly retrieve React, Svelte, Vue, and React Native implementations for your AI-powered development workflow.
- ## β¨ Key Features
- - **π― Multi-Framework Support** - React, Svelte, Vue, and React Native implementations
- - **π¦ Component Source Code** - Latest shadcn/ui v4 TypeScript source
- - **π¨ Component Demos** - Example implementations and usage patterns
- - **ποΈ Blocks Support** - Complete block implementations (dashboards, calendars, forms)
- - **π Metadata Access** - Dependencies, descriptions, and configuration details
- - **π Directory Browsing** - Explore repository structures
- - **β‘ Smart Caching** - Efficient GitHub API integration with rate limit handling, plus protocol cache hints (`ttlMs`/`cacheScope`) on list and read results
- - **β¨οΈ Argument Completion** - Autocomplete for prompt and resource-template arguments (component names, package managers, build tools, and more)
- - **π Streamable HTTP Transport** - Stateless `/mcp` endpoint for multi-client deployments (MCP spec 2026-07-28)
- - **π³ Docker Ready** - Production-ready containerization with Docker Compose
- ## π Quick Start
- ```bash
- # Basic usage (60 requests/hour)
- npx @jpisnice/shadcn-ui-mcp-server
- # With GitHub token (5000 requests/hour) - Recommended
- npx @jpisnice/shadcn-ui-mcp-server --github-api-key ghp_your_token_here
- # Switch frameworks
- npx @jpisnice/shadcn-ui-mcp-server --framework svelte
- npx @jpisnice/shadcn-ui-mcp-server --framework vue
- npx @jpisnice/shadcn-ui-mcp-server --framework react-native
- # Use Base UI instead of Radix (React only)
- npx @jpisnice/shadcn-ui-mcp-server --ui-library base
- ```
- **π― Get your GitHub token in 2 minutes**: [docs/getting-started/github-token.md](docs/getting-started/github-token.md)
- ## π¦ One-Click Installation (Claude Desktop)
- Download and double-click the `.mcpb` file for instant installation:
- 1. Download `shadcn-ui-mcp-server.mcpb` from [Releases](https://github.com/Jpisnice/shadcn-ui-mcp-server/releases)
- 2. Double-click the file - Claude Desktop opens automatically
- 3. Enter your GitHub token (optional, for higher rate limits)
- 4. Click Install - tools are available immediately
- **Manual install:** Claude Desktop β Settings β MCP β Add Server β Browse β Select `.mcpb` file
- > **References:** [Anthropic Desktop Extensions](https://www.anthropic.com/engineering/desktop-extensions) | [Building MCPB](https://support.claude.com/en/articles/12922929-building-desktop-extensions-with-mcpb)
- ## π HTTP Transport & Docker Deployment
- The server implements the **2026-07-28 MCP specification** (via MCP TypeScript SDK v2) and stays compatible with 2025-era clients. To make your client use the modern protocol, or to require it, see the [Modern Protocol Guide](docs/getting-started/modern-protocol.md). Besides stdio, it can serve **Streamable HTTP** at a single stateless `/mcp` endpoint for multi-client and production deployments:
- ### Quick Start with HTTP
- ```bash
- # HTTP mode (stateless, supports many concurrent clients)
- node build/index.js --mode http --port 7423
- # Docker Compose (production ready)
- docker-compose up -d
- # Connect with Claude Code
- claude mcp add --scope user --transport http shadcn-mcp-server http://localhost:7423/mcp
- ```
- ### Transport Modes
- - **`stdio`** (default) - Standard input/output for CLI usage
- - **`http`** - Streamable HTTP at `/mcp`
- - **`dual`** - Both stdio and HTTP simultaneously
- > The legacy SSE transport (`/sse` + `/message`) was removed. `--mode sse` is still accepted as a deprecated alias for `http`.
- ### Docker Examples
- ```bash
- # Basic container
- docker run -p 7423:7423 shadcn-ui-mcp-server
- # With GitHub API token
- docker run -p 7423:7423 -e GITHUB_PERSONAL_ACCESS_TOKEN=ghp_your_token shadcn-ui-mcp-server
- # Docker Compose (recommended)
- docker-compose up -d
- curl http://localhost:7423/health
- ```
- ### Environment Variables
- - `MCP_TRANSPORT_MODE` - Transport mode (stdio|http|dual)
- - `MCP_PORT` - HTTP server port (default: 7423 - SHADCN on keypad!)
- - `MCP_HOST` - Host binding (default: 0.0.0.0)
- - `MCP_CORS_ORIGINS` - CORS origins (comma-separated)
- - `MCP_PROTOCOL` - Protocol eras to accept: `any` (default; 2026-07-28 plus 2025-era fallback) or `modern` (2026-07-28 only). CLI: `--protocol`
- - `GITHUB_PERSONAL_ACCESS_TOKEN` - GitHub API token
- - `UI_LIBRARY` - UI primitive library: `radix` (default) or `base` (React only)
- ## π Documentation
- | Section | Description |
- |---------|-------------|
- | [π Getting Started](docs/getting-started/) | Installation, setup, and first steps |
- | [βοΈ Configuration](docs/configuration/) | Framework selection, tokens, and options |
- | [π Integration](docs/integration/) | Editor and tool integrations |
- | [π Usage](docs/usage/) | Examples, tutorials, and use cases |
- | [π¨ Frameworks](docs/frameworks/) | Framework-specific documentation |
- | [π Troubleshooting](docs/troubleshooting/) | Common issues and solutions |
- | [π§ API Reference](docs/api/) | Tool reference and technical details |
- ## π¨ Framework Support
- This MCP server supports four popular shadcn implementations:
- | Framework | Repository | Maintainer | Description |
- |-----------|------------|------------|-------------|
- | **React** (default) | [shadcn/ui](https://ui.shadcn.com/) | [shadcn](https://github.com/shadcn) | React components from shadcn/ui v4 |
- | **Svelte** | [shadcn-svelte](https://www.shadcn-svelte.com/) | [huntabyte](https://github.com/huntabyte) | Svelte components from shadcn-svelte |
- | **Vue** | [shadcn-vue](https://www.shadcn-vue.com/) | [unovue](https://github.com/unovue) | Vue components from shadcn-vue |
- | **React Native** | [react-native-reusables](https://github.com/founded-labs/react-native-reusables) | [Founded Labs](https://github.com/founded-labs) | React Native components from react-native-reusables |
- ### UI Library (React only)
- shadcn/ui v4 supports two primitive libraries for React: **Radix UI** (default) and **Base UI**.
- ```bash
- # Radix UI (default)
- npx @jpisnice/shadcn-ui-mcp-server --framework react --ui-library radix
- # Base UI
- npx @jpisnice/shadcn-ui-mcp-server --framework react --ui-library base
- # Or via environment variable
- UI_LIBRARY=base npx @jpisnice/shadcn-ui-mcp-server
- ```
- Claude Desktop config example:
- ```json
- {
- "args": ["--framework", "react", "--ui-library", "base"]
- }
- ```
- ## π οΈ Essential Setup
- ### 1. Get GitHub Token (Recommended)
- ```bash
- # Visit: https://github.com/settings/tokens
- # Generate token with no scopes needed
- export GITHUB_PERSONAL_ACCESS_TOKEN=ghp_your_token_here
- ```
- ### 2. Run Server
- ```bash
- # React (default)
- npx @jpisnice/shadcn-ui-mcp-server
- # Svelte
- npx @jpisnice/shadcn-ui-mcp-server --framework svelte
- # Vue
- npx @jpisnice/shadcn-ui-mcp-server --framework vue
- # React Native
- npx @jpisnice/shadcn-ui-mcp-server --framework react-native
- ```
- ### 3. Integrate with Your Editor
- - **Autohand Code**: See [Autohand Code Integration](#-autohand-code-integration) below
- - **Claude Code**: See [Claude Code Integration](#-claude-code-integration) below
- - **VS Code**: [docs/integration/vscode.md](docs/integration/vscode.md)
- - **Cursor**: [docs/integration/cursor.md](docs/integration/cursor.md)
- - **Claude Desktop**: [docs/integration/claude-desktop.md](docs/integration/claude-desktop.md)
- - **Continue.dev**: [docs/integration/continue.md](docs/integration/continue.md)
- ## π» Autohand Code Integration
- Use the [Autohand Code CLI](https://github.com/autohandai/code-cli/) to add the shadcn/ui MCP server:
- ```bash
- autohand mcp add shadcn bunx -y @jpisnice/shadcn-ui-mcp-server --github-api-key YOUR_TOKEN
- ```
- Add `--scope project` before `shadcn` to save the server in the current project's `.autohand` configuration instead of your user configuration.
- ## π» Claude Code Integration
- ### Quick Add (CLI)
- ```bash
- # Add the shadcn-ui MCP server
- claude mcp add shadcn -- bunx -y @jpisnice/shadcn-ui-mcp-server --github-api-key YOUR_TOKEN
- ```
- ### HTTP Transport
- For production deployments with the Streamable HTTP transport:
- ```bash
- # Start server in HTTP mode
- node build/index.js --mode http --port 7423
- # Connect with Claude Code
- claude mcp add --scope user --transport http shadcn-mcp-server http://localhost:7423/mcp
- ```
- ### Framework-Specific Commands
- See [Claude Code Integration Guide](docs/integration/claude-code.md) for framework-specific commands (React, Svelte, Vue, React Native).
- > **Reference:** [Claude Code MCP Documentation](https://code.claude.com/docs/en/mcp)
- ## π― Use Cases
- - **AI-Powered Development** - Let AI assistants build UIs with shadcn/ui
- - **Multi-Client Deployments** - Stateless HTTP transport scales horizontally without sticky sessions
- - **Production Environments** - Docker Compose ready with health checks and monitoring
- - **Component Discovery** - Explore available components and their usage
- - **Multi-Framework Learning** - Compare React, Svelte, Vue, and React Native implementations
- - **Rapid Prototyping** - Get complete block implementations for dashboards, forms, etc.
- - **Code Generation** - Generate component code with proper dependencies
- ## π¦ Installation
- ```bash
- # Global installation (optional)
- npm install -g @jpisnice/shadcn-ui-mcp-server
- # Or use npx (recommended)
- npx @jpisnice/shadcn-ui-mcp-server
- ```
- ## π¨ Building from Source
- ### Prerequisites
- - Node.js >= 20.0.0
- - npm or pnpm
- ### Build Steps
- ```bash
- # Clone the repository
- git clone https://github.com/Jpisnice/shadcn-ui-mcp-server.git
- cd shadcn-ui-mcp-server
- # Install dependencies
- npm install
- # Build the project
- npm run build
- # Run the server
- node build/index.js --github-api-key YOUR_TOKEN
- ```
- ### Run Locally
- ```bash
- # After building, run with options
- node build/index.js --github-api-key YOUR_TOKEN
- node build/index.js --framework svelte
- ```
- ### Building MCPB Package
- The project includes a `manifest.json` following the [MCPB specification](https://github.com/modelcontextprotocol/mcpb). The `.mcpb` file is a ZIP archive containing the server, dependencies, and configuration.
- See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed packaging instructions.
- > **Reference:** [Building Desktop Extensions with MCPB](https://support.claude.com/en/articles/12922929-building-desktop-extensions-with-mcpb)
- ## π Quick Links
- - π [Full Documentation](docs/)
- - π [Getting Started Guide](docs/getting-started/)
- - π [HTTP Transport & Docker Guide](HTTP_TRANSPORT.md)
- - π§ [Modern Protocol Guide (2026-07-28)](docs/getting-started/modern-protocol.md)
- - π [Changelog](CHANGELOG.md)
- - π¨ [Framework Comparison](docs/frameworks/)
- - π§ [API Reference](docs/api/)
- - π [Troubleshooting](docs/troubleshooting/)
- - π¬ [Issues & Discussions](https://github.com/Jpisnice/shadcn-ui-mcp-server)
- ## π License
- MIT License - see [LICENSE](LICENSE) for details.
- ## π Acknowledgments
- - **[shadcn](https://github.com/shadcn)** - For the amazing React UI component library
- - **[huntabyte](https://github.com/huntabyte)** - For the excellent Svelte implementation
- - **[unovue](https://github.com/unovue)** - For the comprehensive Vue implementation
- - **[Founded Labs](https://github.com/founded-labs)** - For the React Native implementation
- - **[Anthropic](https://anthropic.com)** - For the Model Context Protocol specification
- ---
- **Made with β€οΈ by [Janardhan Polle](https://github.com/Jpisnice)**
- **Star β this repo if you find it helpful!**
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If itβs helped, pass it on.