registry/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
adam jones 6b84493ca9
api: Use Huma to generate swagger docs and parse JSON automatically (#262)
## Motivation and Context

Currently there's a lot of unsafe manual JSON unmarshalling/marshalling,
and we have to manually keep the openapi schema in sync.

This PR migrates the API to
[Huma](https://github.com/danielgtaylor/huma), which appears like a
popular, well-maintained way to build APIs in Golang. I'm not a Golang
expert, but seemed highly recommended by Reddit + Claude and has a
decent star count. It provides automatic openapi spec generation and
docs hosting, JSON parsing, as well as the ability to add auth
middlewares etc.

## How Has This Been Tested?

Running locally, and poking at the endpoints

## Breaking Changes

Docs are served at `/docs` rather than `/v0/swagger/index.html` now

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [x] Breaking change (fix or feature that would cause existing
functionality to change)
- [x] Documentation update

## Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->
- [x] I have read the [MCP
Documentation](https://modelcontextprotocol.io)
- [x] My code follows the repository's style guidelines
- [x] New and existing tests pass locally
- [x] I have added appropriate error handling
- [x] I have added or updated documentation as needed

## Additional context
<!-- Add any other context, implementation notes, or design decisions
-->
2025-08-13 16:57:55 +01:00
..
server-json Add a status field indicating if a server is deprecated or active (#210) 2025-07-31 07:18:35 -07:00
server-registry-api api: Use Huma to generate swagger docs and parse JSON automatically (#262) 2025-08-13 16:57:55 +01:00
architecture.md Add NuGet to the MCP Registry, similar to npm and Python 2025-07-07 12:28:19 -06:00
design_principles.md Add NuGet to the MCP Registry, similar to npm and Python 2025-07-07 12:28:19 -06:00
faq.md api: Use Huma to generate swagger docs and parse JSON automatically (#262) 2025-08-13 16:57:55 +01:00
MCP Developers Summit 2025 - Registry Talk Slides.pdf Add 2025-05-26 15:42:55 -07:00
new_package_registry.md Add new package registry document 2025-07-07 12:28:19 -06:00
README.md Add new package registry document 2025-07-07 12:28:19 -06:00
roadmap.md Rogue section 2025-06-26 17:18:34 -07:00

Official Registry Documentation

Project Documentation

design_principles.md - Core constraints and principles guiding the registry design

faq.md - Frequently asked questions about the MCP Registry

roadmap.md - High-level roadmap for the MCP Registry development

MCP Developers Summit 2025 - Registry Talk Slides.pdf - Slides from a talk given at the MCP Developers Summit on May 23, 2025, with an up-to-date vision of how we are thinking about the official registry.

API & Technical Specifications

openapi.yaml - OpenAPI specification for the official registry API

api_examples.md - Examples of what data will actually look like coming from the official registry API

architecture.md - Technical architecture, deployment strategies, and data flows

server.json README - description of the server.json purpose and schema

new_package_registry.md - steps to add a new package registry for local server packages