-
Notifications
You must be signed in to change notification settings - Fork 489
Add registry extensions specification #777
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
domdomegg
wants to merge
1
commit into
main
Choose a base branch
from
adamj/extensions-spec
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+70
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Registry Extensions Specification | ||
|
|
||
| A standardized way for registries to provide experimental or community-driven features without committing them to the core API specification. | ||
|
|
||
| ## Motivation | ||
|
|
||
| [The core generic registry API](./generic-registry-api.md) intentionally stays minimal to ensure stability and broad adoption. Extensions provide a path for: | ||
|
|
||
| - **Experimentation**: Try new features without core API changes | ||
| - **Community innovation**: Anyone can implement custom extensions | ||
| - **Gradual adoption**: Popular extensions may inform future core API features | ||
| - **Avoiding breaking changes**: Failed experiments can be deprecated without API versioning churn | ||
|
|
||
| ## URL Structure | ||
|
|
||
| Extensions live under the `/v0/x/` prefix: | ||
|
|
||
| ``` | ||
| /v0/x/<namespace>/<extension>[/<path>] | ||
| ``` | ||
|
|
||
| **Components:** | ||
| - `<namespace>`: Reverse domain ownership (e.g., `com.example`, `io.github.username`) | ||
| - `<extension>`: Extension name (lowercase, hyphens for word separation) | ||
| - `<path>`: Extension-specific path structure (optional) | ||
|
|
||
| **Examples:** | ||
| ``` | ||
| /v0/x/com.example/search?q=database | ||
| /v0/x/com.example/stats | ||
| /v0/x/io.github.username/custom-feature | ||
| ``` | ||
|
|
||
| ## Conventions | ||
|
|
||
| Where possible: | ||
| - Follow standard REST conventions, return simple JSON responses, and avoid special headers | ||
| - For list endpoints, use cursor-based pagination matching the core API | ||
| - Extensions requiring authentication **SHOULD** follow the [Registry Authorization Specification](./registry-authorization.md) | ||
| - Build open-source implementations in a composable way on top of the core APIs (e.g. as opposed to via custom database integration) | ||
|
|
||
| ## Implementation Requirements | ||
|
|
||
| Registries implementing extensions **SHOULD** namespace extensions properly to avoid conflicts. | ||
|
|
||
| Clients consuming extensions **MUST** gracefully handle missing extensions. | ||
|
|
||
| ## Example | ||
|
|
||
| A simple server stats extension: | ||
|
|
||
| ```bash | ||
| GET /v0/x/com.example/stats | ||
| ``` | ||
|
|
||
| ```json | ||
| { | ||
| "totalServers": 1234, | ||
| "totalVersions": 5678, | ||
| "recentPublishes": 42 | ||
| } | ||
| ``` | ||
|
|
||
| ## Future Considerations | ||
|
|
||
| - **Extension discovery**: A potential `/v0/x` endpoint to list available extensions | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do you think we should make this mandatory?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah - I think either:
Thoughts? |
||
| - **Extension metadata**: Standardized metadata format for extension capabilities | ||
| - **Defining common extensions**: Like semantic conventions from OpenTelemetry, develop common extensions that registries can adopt (possibly under an experimental namespace) | ||
| - Search extension for free-text search across server metadata ([#389](https://github.com/modelcontextprotocol/registry/issues/389)) | ||
| - MCP server extension to expose the registry itself as an MCP server for programmatic access ([#24](https://github.com/modelcontextprotocol/registry/issues/24)) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See #756