First Steps
September 4, 2025 ยท View on GitHub
Now that you have the shadcn/ui MCP Server installed, let's make your first component request!
๐ Quick Test
1. Start the Server
# Basic start (React framework)
npx @jpisnice/shadcn-ui-mcp-server
# With GitHub token (recommended)
npx @jpisnice/shadcn-ui-mcp-server --github-api-key ghp_your_token_here
# Different framework
npx @jpisnice/shadcn-ui-mcp-server --framework svelte --github-api-key ghp_your_token_here
npx @jpisnice/shadcn-ui-mcp-server --framework vue --github-api-key ghp_your_token_here
npx @jpisnice/shadcn-ui-mcp-server --framework react-native --github-api-key ghp_your_token_here
2. Verify Server is Running
You should see output like:
INFO: MCP Server starting...
INFO: Framework set to 'react' via command line argument
INFO: MCP Server configured for REACT framework
INFO: Repository: shadcn-ui/ui
INFO: File extension: .tsx
INFO: MCP Server ready
๐ฏ Your First Component Request
Once the server is running, you can ask your AI assistant to:
Get a Component
"Show me the source code for the shadcn/ui button component"
List Available Components
"List all available shadcn/ui components"
Get Component Demo
"Show me how to use the shadcn/ui card component"
Get Component Metadata
"What are the dependencies for the shadcn/ui dialog component?"
๐๏ธ Working with Blocks
Get a Complete Block
"Get the dashboard-01 block implementation"
List Available Blocks
"Show me all available shadcn/ui blocks"
Get Block with Components
"Get the calendar-01 block with all its component files"
๐ Exploring the Repository
Browse Directory Structure
"Show me the structure of the shadcn/ui repository"
Explore Specific Paths
"Show me the components directory structure"
๐ก Example Conversations
Building a Login Form
You: "Help me build a login form using shadcn/ui components"
AI Assistant: Can now access all form-related components, their source code, and usage examples
Creating a Dashboard
You: "Create a dashboard using shadcn/ui components. Use the dashboard-01 block as a starting point"
AI Assistant: Can retrieve the complete dashboard block and customize it for your needs
Component Comparison
You: "Compare the button component implementations between React and Svelte"
AI Assistant: Can switch frameworks and show you both implementations
๐ง Integration Examples
VS Code with Continue Extension
- Install Continue Extension in VS Code
- Configure MCP Server in settings
- Ask questions directly in your editor
Claude Desktop
- Add MCP Server to Claude Desktop configuration
- Start conversation with Claude
- Request components naturally
Cursor
- Configure MCP Server in Cursor settings
- Use AI features with shadcn/ui access
- Generate code with proper components
๐จ Framework-Specific Examples
React (Default)
"Show me the React button component with TypeScript"
"Get the React card component demo"
"List all React components available"
Svelte
"Show me the Svelte button component"
"Get the Svelte card component with usage examples"
"Compare Svelte and React button implementations"
Vue
"Show me the Vue button component"
"Get the Vue card component demo"
"List all Vue components available"
React Native
"Show me the React Native button component"
"List all React Native components available"
"Get the React Native input component metadata"
๐ Next Steps
- Integration - Connect to your preferred editor or tool
- Usage Examples - More detailed examples and tutorials
- API Reference - Complete tool reference
- Troubleshooting - Common issues and solutions
๐ฏ Success Indicators
You'll know it's working when:
- โ Server starts without errors
- โ AI assistant can retrieve component source code
- โ Component code includes proper imports and dependencies
- โ Framework-specific syntax is correct
- โ Blocks include all necessary component files
๐ Common First-Time Issues
Server Won't Start
# Check Node.js version
node --version # Should be 18+
# Check if npx is available
npx --version
Rate Limit Errors
# Add GitHub token
npx @jpisnice/shadcn-ui-mcp-server --github-api-key ghp_your_token_here
Component Not Found
# Check available components first
# Ask AI assistant: "List all available components"
Framework Issues
# Verify framework selection
npx @jpisnice/shadcn-ui-mcp-server --framework svelte --help