Skip to content

jamesmontemagno/mcp-badge-creator

Repository files navigation

πŸŽ–οΈ MCP Badge Creator

Create beautiful one-click install badges for your Model Context Protocol (MCP) servers that work with VS Code, VS Code Insiders, Visual Studio, Cursor, Goose, and LM Studio.

🌟 Features

  • βœ… Easy to Use: Simple form-based interface to generate badges
  • 🎨 Multiple IDEs: Support for VS Code, VS Code Insiders, Visual Studio, Cursor, Goose, and LM Studio
  • πŸ”§ Six Configuration Types:
    • Remote HTTP Server (HTTP/SSE transport)
    • NPX Package (Node.js packages)
    • UVX Package (Python packages with uv)
    • DNX Package (.NET packages)
    • Docker Container
    • Local Binary (custom commands)
  • πŸ“‹ Copy to Clipboard: One-click copy of generated markdown
  • πŸ“„ README Export: Generate complete "Getting Started" section for your README with installation instructions for all supported IDEs
  • πŸ–₯️ CLI Commands: Generate cross-platform code --add-mcp commands for terminal installation
  • πŸ‘οΈ Live Preview: See your badges before copying
  • 🎨 Beautiful Design: Modern, responsive UI with VS Code Insiders green theme

πŸš€ Live Demo

Visit the live application: MCP Badge Creator

πŸ“– About MCP Badges

MCP badges provide a seamless way for users to install your Model Context Protocol servers directly into their IDE with a single click. These badges:

  • Generate proper install URLs for each IDE
  • Handle URL encoding of JSON configurations
  • Follow official badge styling guidelines
  • Support all MCP server deployment methods

πŸ› οΈ Supported Configuration Types

1. Remote HTTP Server

For MCP servers hosted remotely and accessible via HTTP/HTTPS with SSE transport.

{
  "servers": {
    "server-name": {
      "type": "http",
      "url": "https://your-server-url.com"
    }
  }
}

2. NPX Package (Node.js)

For MCP servers distributed as NPM packages, commonly used in the MCP ecosystem.

{
  "command": "npx",
  "args": ["-y", "@modelcontextprotocol/server-filesystem"],
  "env": {}
}

Common Examples:

  • @modelcontextprotocol/server-filesystem - File system operations
  • @modelcontextprotocol/server-github - GitHub API integration
  • @modelcontextprotocol/server-postgres - PostgreSQL database access

3. UVX Package (Python)

For Python-based MCP servers using uv/uvx for fast, reliable Python package execution.

{
  "command": "uvx",
  "args": ["--from", "mcp-server-git", "mcp-server-git"],
  "env": {}
}

Alternative without --from:

{
  "command": "uvx",
  "args": ["mcp-server-git"],
  "env": {}
}

4. DNX Package (.NET)

For .NET-based MCP servers using DNX package manager.

{
  "command": "dnx",
  "args": ["[email protected]", "--yes"],
  "env": {}
}

5. Docker Container

For MCP servers packaged as Docker images.

{
  "command": "docker",
  "args": ["run", "-i", "--rm", "your-username/your-image"],
  "env": {}
}

6. Local Binary

For MCP servers running as local executables with custom commands.

{
  "command": "node",
  "args": ["path/to/server.js"],
  "env": {}
}

Other common commands:

  • python - For Python scripts
  • uv - For uv-managed Python projects
  • Custom binaries in your PATH

🎯 How It Works

  1. Fill in Server Details: Enter your MCP server name and configuration
  2. Choose Configuration Type: Select between HTTP, NPX, UVX, DNX, Docker, or Local
  3. Select Target IDEs: Choose which IDEs to generate badges for
  4. Copy & Use:
    • Copy the generated markdown badges for your README
    • Copy the JSON configuration for manual setup
    • Copy the CLI commands for terminal installation
    • Export a complete "Getting Started" README section with installation instructions for all IDEs

🎨 Supported IDEs

The badge creator supports one-click install badges for the following IDEs:

  • VS Code - Visual Studio Code stable release
  • VS Code Insiders - Visual Studio Code preview builds
  • Visual Studio - Full IDE experience with MCP support
  • Cursor - AI-powered code editor with MCP integration
  • Goose - AI coding assistant with MCP support
  • LM Studio - Local LLM platform with MCP server support

Each IDE has its own deeplink protocol for seamless installation:

  • VS Code/Insiders: vscode.dev/redirect/mcp/install
  • Visual Studio: vs-open.link/mcp-install
  • Cursor: cursor://anysphere.cursor-deeplink/mcp/install
  • Goose: goose://install-mcp
  • LM Studio: lmstudio://add_mcp

πŸ“„ README Export Feature

The "Getting Started README" tab generates a complete, ready-to-use Getting Started section for your project's README that includes:

  • All one-click install badges for supported IDEs
  • Detailed manual installation instructions for each IDE
  • CLI commands for VS Code and VS Code Insiders
  • Configuration details and examples
  • Help section with links to MCP documentation

Simply click the tab, copy the content, and paste it directly into your README.md file!

πŸ–₯️ CLI Command Installation

The badge creator also generates ready-to-use CLI commands for installing MCP servers:

# For VS Code
code --add-mcp '{\"name\":\"server-name\",\"command\":\"npx\",\"args\":[\"-y\",\"package\"],\"env\":{}}'

# For VS Code Insiders
code-insiders --add-mcp '{\"name\":\"server-name\",\"command\":\"npx\",\"args\":[\"-y\",\"package\"],\"env\":{}}'

These commands work cross-platform in:

  • βœ… PowerShell (Windows)
  • βœ… Bash (Linux/macOS)
  • βœ… Zsh (macOS default)

See CLI-COMMANDS.md for detailed documentation and examples.

πŸ’» Development

Prerequisites

  • Node.js 18+
  • npm or yarn

Setup

# Clone the repository
git clone https://github.com/YOUR_USERNAME/mcp-badge-creator.git
cd mcp-badge-creator

# Install dependencies
npm install

# Start development server
npm run dev

Build

# Build for production
npm run build

# Preview production build
npm run preview

πŸš€ Deployment to GitHub Pages

This project is configured to automatically deploy to GitHub Pages using GitHub Actions.

Setup Instructions

  1. Push your code to GitHub
  2. Go to your repository Settings > Pages
  3. Under "Build and deployment", select "GitHub Actions" as the source
  4. The site will automatically deploy on every push to the main branch

Manual Deployment

Alternatively, you can use gh-pages:

# Install gh-pages
npm install --save-dev gh-pages

# Deploy
npm run deploy

πŸ“š Resources

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

πŸ“„ License

MIT License - feel free to use this tool for your projects!

πŸ™ Acknowledgments


Made with ❀️ for the MCP community

πŸ§ͺ CSS Modules Migration Progress

The project is undergoing a migration from a monolithic App.css (~1,945 lines) to a modular CSS Modules architecture with a global design system.

Phase Checklist

  • Phase 1: Global design system (tokens.css, themes.css, utilities.css)
  • Phase 2: External SVG icons (chevron-down.svg, hamburger.svg)
  • Phase 3: Shared component modules (Button, Card, Form, Badge)
  • Phase 4: App layout migration (App.module.css, refactor App.tsx)
  • Phase 5: Home page migration (Home.module.css)
  • Phase 6: Extensions page migration (Extensions.module.css)
  • Phase 7: Complex pages migration (MCP.module.css, Packages.module.css, Settings.module.css)

Goals

  • Reduce stylesheet size and improve maintainability
  • Eliminate hardcoded colors and duplicated patterns
  • Standardize breakpoints (≀768px, 769–1024px, β‰₯1025px)
  • Introduce reusable component styling primitives
  • Preserve backward compatibility during migration (legacy class names kept temporarily for tests)

Follow progress or contribute by checking the plan in specs/CSS_MODULES_MIGRATION_PLAN.md.

About

Add badges for your README to install MCP servers in VS Code & Visual Studio

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published