DocumentationBadges & Embeds

Security Badges

Display your MCP server's security grade in your README

MCPSafe badges let you showcase your server's security rating directly in your GitHub README, documentation, or website. The badges update automatically whenever your server is rescanned, ensuring visitors always see the latest security status.

A+ Badge ExampleA+ Grade
B Badge ExampleB Grade
F Badge ExampleF Grade
No VulnerabilitiesNo Vulns

Quick Start

Add a security badge to your README in seconds. Just copy the code below and replace your-server-slug with your server's slug from the MCPSafe registry.

[![MCPSafe Security](https://api.mcpsafe.dev/api/badge/your-server-slug.svg)](https://mcpsafe.dev/registry/your-server-slug)

Finding your server slug

Your server's slug is the last part of its MCPSafe URL. For example, if your server is at mcpsafe.dev/registry/my-awesome-server, then your slug is my-awesome-server.

Badge Types

MCPSafe offers several badge types to suit different needs. Choose the one that best fits your README or documentation.

Security Badge

/api/badge/:slug.svg

Shows grade and score (e.g., A+ (98))

![Security Badge](https://api.mcpsafe.dev/api/badge/your-server-slug.svg)

Grade Badge

/api/badge/:slug/grade.svg

Shows only the security grade (A+, A, B, C, D, F)

![Grade Badge](https://api.mcpsafe.dev/api/badge/your-server-slug/grade.svg)

Score Badge

/api/badge/:slug/score.svg

Shows numeric score (e.g., 98/100)

![Score Badge](https://api.mcpsafe.dev/api/badge/your-server-slug/score.svg)

Vulnerabilities Badge

/api/badge/:slug/vulnerabilities.svg

Shows vulnerability count

![Vulnerabilities Badge](https://api.mcpsafe.dev/api/badge/your-server-slug/vulnerabilities.svg)

Badge Styles

Customize the appearance of your badge with different styles. Add thestyle query parameter to your badge URL.

flat
style=flat

The classic badge style with subtle gradient

flat style badge

flat-square
style=flat-square

Flat style with sharp corners

flat-square style badge

for-the-badge
style=for-the-badge

Larger badge with uppercase text

for-the-badge style badge

plastic
style=plastic

3D-style badge with glossy effect

plastic style badge

Example with style parameter

![MCPSafe](https://api.mcpsafe.dev/api/badge/your-server-slug.svg?style=for-the-badge)

Customization

Customize your badge with query parameters to match your project's style.

Query Parameters

ParameterTypeDescription
stylestringBadge style: flat,flat-square,for-the-badge,plastic
labelstringCustom label text (default: "mcpsafe")
labelColorhex colorLabel background color (6-digit hex without #)
colorhex colorOverride the status color (6-digit hex without #)

Badge Builder

Customize your badge and copy the generated code

Preview (using placeholder):

Badge preview
[![MCPSafe Security](https://api.mcpsafe.dev/api/badge/my-mcp-server.svg)](https://mcpsafe.dev/registry/my-mcp-server)

README Examples

Here are some examples of how to use MCPSafe badges in your project README.

Basic Security Badge

Simple badge showing security grade and score

# My MCP Server

[![MCPSafe Security](https://api.mcpsafe.dev/api/badge/my-mcp-server.svg)](https://mcpsafe.dev/registry/my-mcp-server)

A powerful MCP server for...

Multiple Badges

Combine with other popular badges

# My MCP Server

[![npm version](https://img.shields.io/npm/v/my-mcp-server.svg)](https://www.npmjs.com/package/my-mcp-server)
[![MCPSafe Security](https://api.mcpsafe.dev/api/badge/my-mcp-server.svg)](https://mcpsafe.dev/registry/my-mcp-server)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A powerful MCP server for...

Large Style Header

Using for-the-badge style for prominent display

# My MCP Server

<p align="center">
  <img src="https://api.mcpsafe.dev/api/badge/my-mcp-server.svg?style=for-the-badge" alt="MCPSafe Security" />
</p>

A powerful MCP server for...

With Vulnerability Badge

Show both security grade and vulnerability count

# My MCP Server

[![MCPSafe Security](https://api.mcpsafe.dev/api/badge/my-mcp-server.svg)](https://mcpsafe.dev/registry/my-mcp-server)
[![Vulnerabilities](https://api.mcpsafe.dev/api/badge/my-mcp-server/vulnerabilities.svg)](https://mcpsafe.dev/registry/my-mcp-server)

A powerful MCP server for...

Haven't scanned your server yet?

Submit your MCP server for scanning to get your security badge.