<!-- Provide a brief summary of your changes --> ## Motivation and Context This PR ensures that the draft URL points to the actual draft schema improvement suggested in https://github.com/modelcontextprotocol/registry/issues/814 ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> ## Breaking Changes <!-- Will users need to update their code or configurations? --> ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [ ] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [ ] My code follows the repository's style guidelines - [ ] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions -->
1.6 KiB
Contributing to server.json Schema
This document describes the process for making and releasing changes to the server.json schema.
Making Changes
-
Modify the OpenAPI spec: Edit
docs/reference/api/openapi.yamlwith your schema changes. TheServerDetailcomponent defines the server.json structure. -
Regenerate the schema: Run
make generate-schemato updateserver.schema.jsonfrom the OpenAPI spec. -
Update the changelog: Add your changes to the "Draft (Unreleased)" section in
CHANGELOG.md. -
Open a PR: Submit a pull request to this repository for review.
Releasing Changes
When the draft changes are ready for release:
-
Update the changelog: Move changes from "Draft (Unreleased)" to a new dated section (e.g.,
## 2025-XX-XX). -
Update the schema URL: Change the
$idin the schema and the example URL inopenapi.yamlfromdraftto the release date (e.g.,2025-XX-XX). -
Merge the PR: Get approval and merge the changes to main.
-
Publish to static hosting: Open a PR on modelcontextprotocol/static to add the new versioned schema file. This "locks in" the released schema at its versioned URL.
Schema Versioning
- Draft schema:
https://raw.githubusercontent.com/modelcontextprotocol/registry/main/docs/reference/server-json/draft/server.schema.json- For in-progress changes, may change without notice. - Released schemas:
https://static.modelcontextprotocol.io/schemas/YYYY-MM-DD/server.schema.json- Stable, versioned by release date.