examples.sh•2.74 kB
#!/bin/bash
# Example usage script for shadcn-ui-mcp-server
# This demonstrates different ways to use the package
echo "🚀 Shadcn UI MCP Server - Usage Examples"
echo "========================================"
echo ""
# Basic usage
echo "1️⃣ Basic Usage (no GitHub token - rate limited):"
echo " npx shadcn-ui-mcp-server"
echo ""
# With GitHub token via argument
echo "2️⃣ With GitHub Token (command line):"
echo " npx shadcn-ui-mcp-server --github-api-key ghp_your_token_here"
echo " npx shadcn-ui-mcp-server -g ghp_your_token_here"
echo ""
# With environment variable
echo "3️⃣ With GitHub Token (environment variable):"
echo " export GITHUB_PERSONAL_ACCESS_TOKEN=ghp_your_token_here"
echo " npx shadcn-ui-mcp-server"
echo ""
# Claude Desktop integration
echo "4️⃣ Claude Desktop Integration:"
echo " Add to ~/.config/Claude/claude_desktop_config.json:"
echo ' {'
echo ' "mcpServers": {'
echo ' "shadcn-ui": {'
echo ' "command": "npx",'
echo ' "args": ["shadcn-ui-mcp-server", "--github-api-key", "ghp_your_token"]'
echo ' }'
echo ' }'
echo ' }'
echo ""
# Continue.dev integration
echo "5️⃣ Continue.dev Integration:"
echo " Add to .continue/config.json:"
echo ' {'
echo ' "tools": [{'
echo ' "name": "shadcn-ui",'
echo ' "type": "mcp",'
echo ' "command": "npx",'
echo ' "args": ["shadcn-ui-mcp-server"],'
echo ' "env": {"GITHUB_PERSONAL_ACCESS_TOKEN": "ghp_your_token"}'
echo ' }]'
echo ' }'
echo ""
# Available tools
echo "🛠️ Available Tools:"
echo " • get_component - Get component source code"
echo " • get_component_demo - Get component usage examples"
echo " • list_components - List all available components"
echo " • get_component_metadata - Get component dependencies"
echo " • get_block - Get complete block implementations"
echo " • list_blocks - List all available blocks"
echo " • get_directory_structure - Explore repository structure"
echo ""
# React Native examples
echo "6️⃣ React Native Examples:"
echo " # Use React Native framework"
echo " npx shadcn-ui-mcp-server --framework react-native"
echo ""
echo " # list_components (MCP JSON example)"
echo ' {"tool": "list_components", "arguments": {}}'
echo ""
echo " # get_component (button)"
echo ' {"tool": "get_component", "arguments": {"componentName": "button"}}'
echo ""
echo " # get_component_metadata (input)"
echo ' {"tool": "get_component_metadata", "arguments": {"componentName": "input"}}'
echo ""
echo "📚 For more information:"
echo " npx shadcn-ui-mcp-server --help"
echo " https://github.com/yourusername/shadcn-ui-mcp-server"