What is Shadcn Ui Mcp Server

shadcn-ui-mcp-server is a TypeScript-based MCP server that provides reference information for shadcn/ui components. It facilitates AI assistants in accessing documentation and examples related to shadcn/ui components.

Use cases

Use cases include providing developers with quick access to component documentation, examples, and installation instructions, as well as aiding in the search for specific components based on keywords.

How to use

To use shadcn-ui-mcp-server, you need to configure it in your application. You can either build it locally or use it via npx. Configuration involves adding the server command to your application’s configuration files, such as Claude Desktop, Windsurf, or Cursor.

Key features

Key features include tools for listing available components, retrieving detailed information about specific components, obtaining usage examples, and searching for components by keywords. It also scrapes and caches data from the official shadcn/ui documentation and GitHub repository.

Where to use

shadcn-ui-mcp-server can be used in web development projects that utilize shadcn/ui components, particularly in environments where AI assistants are integrated for enhanced documentation access.

shadcn-ui MCP Server

MCP server for shadcn/ui component references

This is a TypeScript-based MCP server that provides reference information for shadcn/ui components. It implements a Model Context Protocol (MCP) server that helps AI assistants access shadcn/ui component documentation and examples.

Features

Tools

• list_shadcn_components - Get a list of all available shadcn/ui components
• get_component_details - Get detailed information about a specific component
• get_component_examples - Get usage examples for a specific component
• search_components - Search for components by keyword

Functionality

This server scrapes and caches information from:

• The official shadcn/ui documentation site (https://ui.shadcn.com)
• The shadcn/ui GitHub repository

It provides structured data including:

• Component descriptions
• Installation instructions
• Usage examples
• Props and variants
• Code samples

Development

Install dependencies:

npm install

Build the server:

npm run build

For development with auto-rebuild:

npm run watch

Installation

Claude Desktop Configuration

To use with Claude Desktop, add the server config:

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

Option 1: Using local build

{
  "mcpServers": {
    "shadcn-ui-server": {
      "command": "/path/to/shadcn-ui-server/build/index.js"
    }
  }
}

Option 2: Using npx command

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

Windsurf Configuration

Add this to your ./codeium/windsurf/model_config.json:

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

Cursor Configuration

Add this to your .cursor/mcp.json:

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

Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the MCP Inspector, which is available as a package script:

npm run inspector

The Inspector will provide a URL to access debugging tools in your browser.