Skip to content

registry-schema-toolhive.mdx

Latest commit

 

History

History
45 lines (34 loc) · 1.42 KB

registry-schema-toolhive.mdx

File metadata and controls

45 lines (34 loc) · 1.42 KB
title ToolHive registry JSON schema
description JSON schema reference for ToolHive registry entries, including server metadata and configuration fields.
displayed_sidebar toolhiveSidebar

import JSONSchemaViewer from '@theme/JSONSchemaViewer'; import Schema from '@site/static/api-specs/toolhive-legacy-registry.schema.json';

This is the JSON schema for the ToolHive-native registry format. It defines the structure and constraints for registry entries, ensuring that all entries conform to a consistent format.

:::warning[Legacy format no longer accepted]

This format is no longer accepted by ToolHive. The CLI, UI, and Registry Server all consume the upstream MCP registry format. The schema is preserved here for reference only.

To migrate an existing custom registry file, run:

thv registry convert --in <path> --in-place

The conversion is lossless: every ToolHive-specific field is mapped to a publisher-provided extension on the corresponding upstream server entry. See thv registry convert for details.

:::

To use this schema in your own custom registry file, add a $schema property at the top of your JSON file:

{
  "$schema": "https://raw.githubusercontent.com/stacklok/toolhive-core/main/registry/types/data/toolhive-legacy-registry.schema.json",
  ...
}