Markdown Usage

Add MCPSafe security badges to your README.md and other markdown documentation.

Basic Usage

Simple Badge with Link

The most common way to add a badge to your README

README.md

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

Preview:

MCPSafeA (92)

With Custom Style

For The Badge Style

Use a larger, more prominent badge style

README.md

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

Preview:

MCPSafeA (92)

Multiple Badges

Badge Row

Combine with other badges for a professional README header

README.md

# My MCP Server

[![MCPSafe Security](https://api.mcpsafe.org/api/badge/my-server?style=flat-square)](https://mcpsafe.org/registry/my-server)
[![npm version](https://img.shields.io/npm/v/@my-org/my-server.svg)](https://www.npmjs.com/package/@my-org/my-server)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

A secure MCP server for...

Preview:

MCPSafeA (92)

npmv1.2.0

licenseMIT

Reference Style Links

Cleaner Markdown

Keep your README cleaner with reference-style links

README.md

<!-- At the top of your README -->
[![MCPSafe Security][mcpsafe-badge]][mcpsafe-url]

<!-- At the bottom of your README -->
[mcpsafe-badge]: https://api.mcpsafe.org/api/badge/your-server-slug?style=flat-square
[mcpsafe-url]: https://mcpsafe.org/registry/your-server-slug

Benefits

• Easier to read and maintain
• URLs defined once at the bottom
• Simple to update badge URLs

Finding Your Server Slug

Your server slug is the unique identifier in the MCPSafe registry URL:

https://mcpsafe.org/registry/your-server-slug

You can find your slug by visiting your server's page in the MCPSafe registry and copying it from the URL.

Tips

Keep badges at the top

Users see them first when visiting your repo

Always link to your report

Let users click through for details

Match badge styles

Use the same style for all badges in a row

Badge auto-updates

Grade reflects your latest scan results