Skip to content

Document nested Kubernetes metadata in registry extensions #530

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.

Sign up for GitHub

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

Merged
danbarr merged 1 commit into from
Feb 6, 2026
+14 −3
Merged

Document nested Kubernetes metadata in registry extensions #530

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions docs/toolhive/reference/registry-schema-upstream.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,24 @@ The available properties vary by server type:
- **All servers**: `status`, `tier`, `tools`, `tags`, `metadata`, and
`custom_metadata`

:::note Read-only metadata

The `metadata` object can include an optional `kubernetes` nested object with
fields like `kind`, `namespace`, `name`, `uid`, `image`, and `transport`. This
metadata is automatically added by the ToolHive Registry Server for servers that
were auto-discovered from Kubernetes deployments (typically remote servers
accessed via Kubernetes-exposed URLs). You should not manually add this field
when creating custom registry files.

:::

<JSONSchemaViewer schema={PublisherProvidedSchema} />

## Full example

The following example shows a complete registry file with both a container
server and a remote server, demonstrating the different ToolHive extensions
available for each type:
The following example shows a complete custom registry file with both a
container server and a remote server, demonstrating the different ToolHive
extensions you can use when building your own registry:

```json title="Example registry file with ToolHive extensions"
{
Expand Down