Skip to content

blackoutsecure/bos-mcp-engine-demo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 

Blackout Secure MCP Engine Demo

A starter repository demonstrating how to define MCP server metadata and generate a static registry using the Blackout Secure MCP Registry Engine.

Quick Start

See live demos deployed on different platforms:

What This Shows

  • Defining MCP servers under servers/<name>/server.json
  • Versioned metadata under servers/<name>/versions/<version>.json
  • Generating static registry output for static hosting platforms
  • Deploying registries to Cloudflare Pages or GitHub Pages
  • Keeping examples simple, public, and easy to understand

Repository Structure

main branch (this branch):

  • Clean starter template
  • Workflow configurations
  • Configuration files (CNAME, LICENSE, etc.)
  • Server metadata added to demo branches

registry-demo-cf branch:

servers/
  echo-demo/
    server.json
    versions/
      1.0.0.json
  filesystem-demo/
    server.json
    versions/
      1.0.0.json
registry/v0.1/       (generated)
.github/workflows/   (Cloudflare deployment)

registry-demo-gh branch:

servers/
  (same structure)
registry/v0.1/       (generated)
.github/workflows/   (GitHub Pages deployment)

How It Works

  1. Define MCP servers in servers/<name>/server.json and versions
  2. Generate static registry using the GitHub Action on each branch
  3. Deploy generated output to static hosting (Cloudflare Pages or GitHub Pages)
  4. Access through the live sites above

The Engine

Registry generation is automated by the Blackout Secure MCP Registry Engine GitHub Action:

Using This as a Template

  1. Fork or clone this repository
  2. Choose a demo branch (registry-demo-cf or registry-demo-gh) to start from
  3. Add your MCP servers under servers/<name>/
  4. Push to trigger the GitHub Action
  5. Deploy to your chosen platform

For detailed examples, see the demo branches.

Important Notes

  • Purpose: This is a public demo repository. Use it as a template or reference.
  • Production: Do not treat generated examples as production content.
  • Engine Implementation: The registry engine lives in a separate repository.
  • Standards: All JSON metadata follows MCP registry schema conventions.

Sponsored by Blackout Secure

This project is developed and maintained by Blackout Secure.

Blackout Secure provides open-source tools and infrastructure for secure model context protocol (MCP) implementations, enabling developers to build reliable and scalable AI integrations.

About

A public demo repository showcasing the BOS MCP Registry Engine. Includes example registries, MCP server definitions, and multiple workflows demonstrating validation, generation, and publishing capabilities across different branches.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors