configuration

Configuration

Detailed configuration options for the shadcn/ui MCP Server.

⚙️ Configuration Options

• Framework Selection - Choosing between React, Svelte, Vue, and React Native
• GitHub Token Setup - Setting up GitHub API access
• Environment Variables - Using environment variables
• Command Line Options - All available CLI options
• Advanced Configuration - Advanced setup options

🚀 Quick Configuration

Basic Setup

# 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

With GitHub Token

# React with token
npx @jpisnice/shadcn-ui-mcp-server --github-api-key ghp_your_token_here

# Svelte with token
npx @jpisnice/shadcn-ui-mcp-server --framework svelte --github-api-key ghp_your_token_here

# Vue with token
npx @jpisnice/shadcn-ui-mcp-server --framework vue --github-api-key ghp_your_token_here

🔧 Command Line Options

shadcn-ui-mcp-server [options]

Options:
  --github-api-key, -g <token>    GitHub Personal Access Token
  --framework, -f <framework>     Framework to use: 'react', 'svelte' or 'vue' (default: react)
                                  Also supports 'react-native'
  --help, -h                      Show help message
  --version, -v                   Show version information

🌍 Environment Variables

# GitHub token
export GITHUB_PERSONAL_ACCESS_TOKEN=ghp_your_token_here

# Framework selection
export FRAMEWORK=svelte

# Run server
npx @jpisnice/shadcn-ui-mcp-server

# React Native via env var
export FRAMEWORK=react-native
npx @jpisnice/shadcn-ui-mcp-server

🎨 Framework Configuration

React (Default)

npx @jpisnice/shadcn-ui-mcp-server
# or
npx @jpisnice/shadcn-ui-mcp-server --framework react

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

🔗 Next Steps

• Framework Selection - Detailed framework configuration
• GitHub Token Setup - Setting up optimal performance
• Environment Variables - Using environment variables
• Command Line Options - Complete CLI reference
• Advanced Configuration - Advanced setup options