Skip to content

Commit 15ef141

Browse files
authored
Drop "Upstream" qualifier from registry schema docs (#873)
1 parent 93b90e4 commit 15ef141

11 files changed

Lines changed: 42 additions & 43 deletions

File tree

docs/toolhive/guides-cli/registry.mdx

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -137,10 +137,10 @@ organizations that want to maintain their own private registry of MCP servers.
137137
ToolHive supports two types of custom registries:
138138

139139
- **File-based registries**: JSON files that follow the
140-
[upstream registry schema](../reference/registry-schema-upstream.mdx)
140+
[ToolHive registry schema](../reference/registry-schema-upstream.mdx)
141141
- **API-based registries**: REST API endpoints that implement the
142142
[MCP Registry API specification](../guides-registry/index.mdx), which use the
143-
[upstream registry schema](../reference/registry-schema-upstream.mdx)
143+
[ToolHive registry schema](../reference/registry-schema-upstream.mdx)
144144

145145
:::warning[Legacy format no longer accepted]
146146

@@ -154,7 +154,7 @@ thv registry convert --in registry.json --in-place
154154
```
155155

156156
The conversion is lossless: every ToolHive-specific field is mapped to a
157-
publisher-provided extension on the corresponding upstream server entry.
157+
publisher-provided extension on the corresponding MCP server entry.
158158

159159
:::
160160

@@ -273,8 +273,8 @@ name, description, and an array of servers:
273273
}
274274
```
275275

276-
See the [upstream registry schema](../reference/registry-schema-upstream.mdx)
277-
for the full server object structure.
276+
See the [registry schema](../reference/registry-schema-upstream.mdx) for the
277+
full server object structure.
278278

279279
### Key characteristics
280280

@@ -289,10 +289,9 @@ for the full server object structure.
289289

290290
### Full example
291291

292-
For a complete custom registry file with both top-level servers and groups in
293-
the upstream format, see the
294-
[Full example](../reference/registry-schema-upstream.mdx#full-example) in the
295-
upstream registry schema reference.
292+
For a complete custom registry file with both top-level servers and groups, see
293+
the [Full example](../reference/registry-schema-upstream.mdx#full-example) in
294+
the registry schema reference.
296295

297296
### Use registry servers with groups
298297

docs/toolhive/guides-registry/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,8 @@ Kubernetes lease name suffixes for leader election.
9797

9898
## Registry data format
9999

100-
The Registry Server reads registry data in the official
101-
[upstream MCP registry format](../reference/registry-schema-upstream.mdx). All
100+
The Registry Server reads registry data in the
101+
[ToolHive registry format](../reference/registry-schema-upstream.mdx). All
102102
synced sources (Git, API, and File) must provide data in this format. For a
103103
walkthrough of what the file looks like and how to land changes in a Git
104104
repository, see [Publish MCP servers](./publish-servers.mdx).

docs/toolhive/guides-registry/deploy-operator.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,7 @@ Common causes include:
827827
- **Source unavailable**: Git repository, API endpoint, or file is inaccessible
828828
- **Invalid JSON format**: Registry file contains invalid JSON
829829
- **Schema mismatch**: The data does not conform to the
830-
[upstream MCP registry schema](../reference/registry-schema-upstream.mdx)
830+
[ToolHive registry schema](../reference/registry-schema-upstream.mdx)
831831
- **Filter too restrictive**: Filters may be excluding all servers
832832

833833
</details>

docs/toolhive/guides-registry/intro.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,8 @@ The server supports five source types:
118118

119119
1. **Managed** - A fully-managed MCP source
120120
- Ideal for hosting private MCP server catalogs
121-
- Automatically exposes entries following upstream MCP Registry format
121+
- Automatically exposes entries following the MCP Registry format with
122+
ToolHive-specific extensions
122123
- Supports publishing MCP servers and skills via the `/v1/entries` admin API
123124

124125
2. **Upstream API** - Sync from upstream MCP Registry APIs
@@ -135,12 +136,12 @@ The server supports five source types:
135136

136137
4. **Git** - Clone and sync from Git repositories
137138
- Supports branch, tag, or commit pinning
138-
- Syncs both MCP servers and skills (upstream format)
139+
- Syncs both MCP servers and skills
139140
- Does not support publishing
140141

141142
5. **File** - Read from filesystem
142143
- Ideal for local development and testing
143-
- Syncs both MCP servers and skills (upstream format)
144+
- Syncs both MCP servers and skills
144145
- Does not support publishing
145146

146147
## Registry Server and the rest of ToolHive

docs/toolhive/guides-registry/publish-servers.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ a `skill` payload instead of a `server` payload.
2828
## Registry file format
2929

3030
Git and file sources both read a single JSON file in the
31-
[upstream MCP registry format](../reference/registry-schema-upstream.mdx). The
32-
file has top-level `version` and `meta` fields, plus a `data` object that holds
31+
[ToolHive registry format](../reference/registry-schema-upstream.mdx). The file
32+
has top-level `version` and `meta` fields, plus a `data` object that holds
3333
`servers` and optionally `skills` arrays. A single file can carry servers,
3434
skills, or both:
3535

@@ -99,13 +99,13 @@ skills, or both:
9999
### Required fields
100100

101101
Each entry in the `data.servers` array needs the following keys, per the
102-
upstream schema:
102+
registry schema:
103103

104104
- `name`: reverse-DNS identifier (for example, `io.github.acme/deploy-helper`).
105105
This is the unique key for the entry.
106106
- `description`: short text displayed in listings.
107107
- `version`: the version this entry represents. Must follow the rules in the
108-
upstream schema.
108+
registry schema.
109109
- Either `packages` (for servers distributed as container images or other
110110
package types) or `remotes` (for remote MCP servers accessed by URL).
111111

@@ -114,9 +114,9 @@ at least one `packages` entry referencing the skill's Git repository or OCI
114114
artifact. See [Manage skills](./skills.mdx) for the full skill-specific field
115115
reference and the managed-source admin API for skills.
116116

117-
See the [upstream registry schema](../reference/registry-schema-upstream.mdx)
118-
for the full field catalog, including optional metadata, tool definitions, and
119-
the ToolHive extensions under
117+
See the [registry schema](../reference/registry-schema-upstream.mdx) for the
118+
full field catalog, including optional metadata, tool definitions, and the
119+
ToolHive extensions under
120120
`_meta["io.modelcontextprotocol.registry/publisher-provided"]`.
121121

122122
### Add the `$schema` property
@@ -189,7 +189,7 @@ source (see
189189

190190
### Validate before committing
191191

192-
Validate the file against the upstream schema locally before opening a PR. Any
192+
Validate the file against the registry schema locally before opening a PR. Any
193193
JSON Schema validator works. For a quick check with
194194
[`check-jsonschema`](https://github.com/python-jsonschema/check-jsonschema):
195195

@@ -276,8 +276,8 @@ curl -X POST \
276276

277277
Required fields in the `server` object: `name`, `description`, `version`, and
278278
either `packages` or `remotes`. See the
279-
[upstream registry schema](../reference/registry-schema-upstream.mdx) for the
280-
full structure and the optional ToolHive extensions.
279+
[registry schema](../reference/registry-schema-upstream.mdx) for the full
280+
structure and the optional ToolHive extensions.
281281

282282
A successful response returns `201 Created` with the published server. If the
283283
version already exists, the server returns `409 Conflict`.
@@ -364,8 +364,8 @@ for the authorization rules.
364364

365365
## Related information
366366

367-
- [Upstream registry JSON schema](../reference/registry-schema-upstream.mdx) -
368-
the full structure and validation rules for server and skill entries
367+
- [Registry JSON schema](../reference/registry-schema-upstream.mdx) - the full
368+
structure and validation rules for server and skill entries
369369
- [Registry Server API reference](../reference/registry-api.mdx) - request and
370370
response schemas for every endpoint
371371
- [Configure sources and registries](./configuration.mdx) - source types, sync

docs/toolhive/guides-registry/quickstart.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ ToolHive CLI and UI, see the [Introduction](./intro.mdx) for a comparison.
2121
- How to install the ToolHive Operator, which bundles the `MCPRegistry` CRD
2222
- How to deploy a minimal PostgreSQL database for the Registry Server
2323
- How to define registry data in a ConfigMap using the
24-
[upstream MCP registry format](../reference/registry-schema-upstream.mdx)
24+
[ToolHive registry format](../reference/registry-schema-upstream.mdx)
2525
- How to create an `MCPRegistry` resource that reads from that ConfigMap
2626
- How to query the Registry API
2727

@@ -184,7 +184,7 @@ the Registry Server pod and points the server at it automatically when you set
184184

185185
Define registry data in a ConfigMap. The Registry Server reads it through a
186186
file-based source. The ConfigMap uses the
187-
[upstream MCP registry format](../reference/registry-schema-upstream.mdx) with a
187+
[ToolHive registry format](../reference/registry-schema-upstream.mdx) with a
188188
single example server entry:
189189

190190
```yaml title="registry-data.yaml"

docs/toolhive/guides-registry/skills.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Skills can come from two paths:
1515
- **Publish to a managed source via the admin API** (covered in depth below).
1616
Good for programmatic or UI-driven publishing with per-version control.
1717
- **Sync from external sources** (Git, upstream API, or file) that contain
18-
skills in the upstream registry format. Good for catalogs that live in a
18+
skills in the ToolHive registry format. Good for catalogs that live in a
1919
repository with code review and CI.
2020

2121
For the file-based path, the registry JSON format is identical to the one used

docs/toolhive/reference/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ tutorials, see the individual product sections.
7272
item={{
7373
type: 'link',
7474
href: '/toolhive/reference/registry-schema-upstream',
75-
label: 'Upstream registry JSON schema',
76-
description: 'JSON schema for the upstream MCP registry format.',
75+
label: 'Registry JSON schema',
76+
description: 'JSON schema for the ToolHive registry format.',
7777
}}
7878
/>
7979

docs/toolhive/reference/registry-schema-upstream.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Upstream registry JSON schema
2+
title: Registry JSON schema
33
description:
44
JSON schema reference for the ToolHive registry format, which builds on the
55
official MCP server schema and adds skills, groups, and publisher-provided
@@ -27,10 +27,9 @@ needs `"servers": []`.
2727
:::info
2828

2929
The CLI, UI, and [Registry Server](/toolhive/guides-registry/intro) all consume
30-
this upstream format. The legacy ToolHive-native registry format is no longer
31-
accepted by `thv config set-registry` or by remote registries; migrate any
32-
existing custom registry file with
33-
[`thv registry convert`](./cli/thv_registry_convert.md).
30+
this format. The legacy ToolHive-native registry format is no longer accepted by
31+
`thv config set-registry` or by remote registries; migrate any existing custom
32+
registry file with [`thv registry convert`](./cli/thv_registry_convert.md).
3433

3534
:::
3635

@@ -57,9 +56,9 @@ official MCP server schema:
5756

5857
## ToolHive extensions schema
5958

60-
ToolHive extends the upstream MCP server schema with additional metadata to
61-
support features like container configuration, authentication, and
62-
categorization. These extensions are stored in the
59+
ToolHive extends the MCP server schema with additional metadata to support
60+
features like container configuration, authentication, and categorization. These
61+
extensions are stored in the
6362
`_meta['io.modelcontextprotocol.registry/publisher-provided']` property of each
6463
server definition.
6564

docs/toolhive/tutorials/custom-registry.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -395,8 +395,8 @@ registries (public or private) as well as remote servers hosted at a URL.
395395
registry with authentication, multiple data sources, and automatic
396396
synchronization
397397
- Explore the full
398-
[upstream registry schema reference](../reference/registry-schema-upstream.mdx)
399-
to understand all available configuration options
398+
[registry schema reference](../reference/registry-schema-upstream.mdx) to
399+
understand all available configuration options
400400
- Learn about [custom permissions](../guides-cli/custom-permissions.mdx) for
401401
fine-grained security control
402402
- Set up [secrets management](../guides-cli/secrets-management.mdx) for servers

0 commit comments

Comments
 (0)