Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
79 changes: 79 additions & 0 deletions docs/toolhive/reference/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: Reference
description:
Technical reference documentation for ToolHive, including CLI commands, API
specifications, CRD definitions, and registry schemas.
displayed_sidebar: toolhiveSidebar
---

import DocCard from '@theme/DocCard';

Technical reference documentation for all ToolHive components. For guides and
tutorials, see the individual product sections.

<div style={{display: 'grid', gridTemplateColumns: 'repeat(auto-fill, minmax(280px, 1fr))', gap: '1rem', margin: '1rem 0'}}>

<DocCard
item={{
type: 'link',
href: '/toolhive/reference/client-compatibility',
label: 'Client compatibility',
description: 'Supported AI clients and how they connect to ToolHive.',
}}
/>

<DocCard
item={{
type: 'link',
href: '/toolhive/reference/cli/thv',
label: 'CLI reference',
description: 'Detailed reference for all ToolHive CLI commands and flags.',
}}
/>

<DocCard
item={{
type: 'link',
href: '/toolhive/reference/api',
label: 'API reference',
description: 'Reference documentation for the ToolHive REST API.',
}}
/>

<DocCard
item={{
type: 'link',
href: '/toolhive/reference/crd-spec',
label: 'Kubernetes CRD reference',
description: 'Reference for Kubernetes Operator custom resources.',
}}
/>

<DocCard
item={{
type: 'link',
href: '/toolhive/reference/registry-api',
label: 'Registry Server API reference',
description: 'REST API reference for the ToolHive Registry Server.',
}}
/>

<DocCard
item={{
type: 'link',
href: '/toolhive/reference/registry-schema-upstream',
label: 'Upstream registry JSON schema',
description: 'JSON schema for the upstream MCP registry format.',
}}
/>

<DocCard
item={{
type: 'link',
href: '/toolhive/reference/registry-schema-toolhive',
label: 'ToolHive registry JSON schema',
description: 'The JSON schema for the ToolHive registry (legacy format).',
}}
/>

</div>
3 changes: 2 additions & 1 deletion docs/toolhive/reference/registry-api.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Registry API reference
title: Registry Server API reference
sidebar_label: API reference
description: Reference documentation for the ToolHive Registry Server REST API
hide_table_of_contents: true
---
Expand Down
22 changes: 4 additions & 18 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,8 @@ const sidebars: SidebarsConfig = {
'toolhive/guides-registry/database',
'toolhive/guides-registry/telemetry-metrics',
'toolhive/reference/registry-api',
'toolhive/reference/registry-schema-upstream',
'toolhive/reference/registry-schema-toolhive',
],
},

Expand Down Expand Up @@ -259,24 +261,8 @@ const sidebars: SidebarsConfig = {
items: [{ type: 'autogenerated', dirName: 'toolhive/guides-mcp' }],
},

{
type: 'category',
label: 'Reference',
description: 'Technical reference material',
link: {
type: 'generated-index',
slug: 'toolhive/reference',
description:
'Technical reference material for ToolHive, including client compatibility, API specifications, and registry schemas.',
},
collapsed: true,
items: [
'toolhive/reference/client-compatibility',
'toolhive/reference/registry-schema-toolhive',
'toolhive/reference/registry-schema-upstream',
],
},

'toolhive/reference/client-compatibility',
'toolhive/reference/index',
'toolhive/faq',
'toolhive/support',
'toolhive/contributing',
Expand Down