docs: recommend namespaced subkeys inside publisher-provided (#1197)
## Summary - Adds a short "Recommended: Namespaced Subkeys" subsection to `official-registry-requirements.md`, documenting the reverse-DNS subkey convention for `publisher-provided` metadata with one worked example - Explicitly notes this is not enforced, to avoid churning the ~15 existing flat-key examples elsewhere in the docs Closes #477 ## Test plan - [ ] Render the file on GitHub and verify the new subsection appears right after the `Publisher-Provided Metadata` size-limit note 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
ccb7057c33
commit
8b893ae1f1
1 changed files with 22 additions and 0 deletions
|
|
@ -69,6 +69,28 @@ When publishing to the official registry, **only data under the specific key `io
|
||||||
|
|
||||||
**Size limit:** The publisher-provided extension is limited to 4KB (4096 bytes) of JSON. If the marshaled JSON exceeds this limit, publishing will fail with an error indicating the actual size.
|
**Size limit:** The publisher-provided extension is limited to 4KB (4096 bytes) of JSON. If the marshaled JSON exceeds this limit, publishing will fail with an error indicating the actual size.
|
||||||
|
|
||||||
|
#### Recommended: Namespaced Subkeys
|
||||||
|
|
||||||
|
When your `publisher-provided` metadata gets large or comes from multiple sources (e.g. GitHub-specific hints alongside your own CI tool's metadata), grouping keys under reverse-DNS subkeys is a useful convention to avoid accidental collisions:
|
||||||
|
|
||||||
|
```jsonc
|
||||||
|
{
|
||||||
|
"_meta": {
|
||||||
|
"io.modelcontextprotocol.registry/publisher-provided": {
|
||||||
|
"com.github": {
|
||||||
|
"serverDisplayName": "My Server"
|
||||||
|
},
|
||||||
|
"io.example.ci-publisher": {
|
||||||
|
"tool": "ci-publisher",
|
||||||
|
"version": "1.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This is **not enforced**; flat keys work fine for simple cases, and existing examples in this repo use the flat form. Use the namespaced form when organizing metadata from more than one source.
|
||||||
|
|
||||||
### Registry API Metadata vs server.json Metadata
|
### Registry API Metadata vs server.json Metadata
|
||||||
|
|
||||||
The `_meta` field in `server.json` is **different** from the `_meta` field returned in registry API responses:
|
The `_meta` field in `server.json` is **different** from the `_meta` field returned in registry API responses:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue