Skip to content

registry-schema-upstream.mdx

Latest commit

 

History

History
44 lines (32 loc) · 1.35 KB

registry-schema-upstream.mdx

File metadata and controls

44 lines (32 loc) · 1.35 KB
title Upstream registry JSON schema
description The JSON schema for the official upstream MCP registry format.
displayed_sidebar toolhiveSidebar

import JSONSchemaViewer from '@theme/JSONSchemaViewer'; import RegistrySchema from '@site/static/api-specs/upstream-registry.schema.json'; import McpServerSchema from '@site/static/api-specs/mcp-server.schema.json';

This is the JSON schema for the official upstream MCP registry format. It defines the structure and constraints for registry entries, ensuring that all entries conform to a consistent format. The registry wraps the official MCP server schema, which is documented separately below.

:::info

ToolHive also supports the ToolHive-native registry format, which is used by the built-in registry. Both formats work with custom file-based registries and the ToolHive Registry Server.

:::

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/main/pkg/registry/data/upstream-registry.schema.json",
  ...
}

Registry schema

MCP server object schema

The servers array in the registry contains objects that conform to the official MCP server schema: