mcp-badges

Get your projects MCP (Model Context Protocol) badges

Installation

Run this command in your terminal to add the MCP server to Claude Code.

Run in terminal:

Command

claude mcp add --transport stdio mcpx-dev-mcp-badges node server.js \
  --env PORT="Port to run the server on (default 3000)" \
  --env MCP_API_BASE="Base URL for MCP API endpoints if needed (optional)"

How to use

This MCP server exposes an API to generate MCP badges for your MCP projects. It leverages the official MCP badge conventions (default, server, client, and dev types) and supports status and features parameters in the query string to render dynamic badges. You can embed these badges into your project READMEs or dashboards to provide at-a-glance status and capability information about your MCP projects. To use it, run the server locally or in your deployment environment, then request badges via simple HTTP requests or by embedding the generated image URLs in Markdown or HTML. The server focuses on returning image assets that conform to the standard badge URLs like the ones documented in the repository, with proper type and feature flags when specified.

How to install

Prerequisites:

Node.js (14.x or newer) and npm installed on your system
Git (optional, for cloning the repository)

Installation steps:

Clone the repository or install via npm if published as a package in your registry:
- git clone https://github.com/your-org/mcp-badges.git
- cd mcp-badges
- npm install
Start the server locally:
- npm run start
- or node server.js
Configure environment variables as needed (example provided in mcp_config):
- PORT=3000
- MCP_API_BASE=https://api.your-mcp-service.local
Verify the server is running by curling the health or a sample badge URL:
- curl http://localhost:3000/health
- curl http://localhost:3000/badge?type=server&features=resources,tools

Additional notes

Notes:

The server supports four badge types: default, server, client, and dev. Use query parameters like type and features to customize the badge.
For server and client badges, you can specify features as a comma-separated list (e.g., features=resources,tools).
Ensure the MCP_API_BASE (if used) is reachable from your deployment environment so that any backend data can be fetched if needed.
If you expose the server publicly, consider rate limiting and caching badge responses to reduce load.
The npm_package field is filled if this is a published Node.js package; otherwise, deploy from source and run as described in installation steps.