Skip to content

Commit bd52f30

Browse files
committed
Update sidebar and add references to JSON schema
Signed-off-by: Dan Barr <[email protected]>
1 parent 3227665 commit bd52f30

File tree

4 files changed

+27
-36
lines changed

4 files changed

+27
-36
lines changed

docs/toolhive/guides-cli/registry.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,15 @@ By default, ToolHive uses a built-in registry of verified MCP servers. You can
132132
configure ToolHive to use a custom registry instead. This is useful for
133133
organizations that want to maintain their own private registry of MCP servers.
134134

135+
The registry is a JSON file that follows the
136+
[ToolHive registry schema](../reference/registry-schema.mdx). Once you configure
137+
a custom registry, ToolHive uses it for all commands that interact with the
138+
registry, such as `thv registry list`, `thv registry info`, and `thv run`.
139+
140+
Refer to the
141+
[built-in registry file](https://github.com/stacklok/toolhive/blob/main/pkg/registry/data/registry.json)
142+
for examples of MCP server entries.
143+
135144
### Set a remote registry URL
136145

137146
To configure ToolHive to use a remote registry, set the registry URL:
@@ -154,14 +163,6 @@ To configure ToolHive to use a local registry, set the registry file:
154163
thv config set-registry <PATH>
155164
```
156165

157-
The registry must be a JSON file that follows the same format as the
158-
[built-in registry](https://github.com/stacklok/toolhive/blob/main/pkg/registry/data/registry.json).
159-
Once you configure a remote registry, all registry commands
160-
([`thv registry list`](../reference/cli/thv_registry_list.md),
161-
[`thv registry info`](../reference/cli/thv_registry_info.md),
162-
[`thv search`](../reference/cli/thv_search.md)) will use the remote registry
163-
instead of the built-in one.
164-
165166
### Check the current registry location
166167

167168
To see which registry (URL or path) is currently configured:
@@ -189,6 +190,8 @@ This restores the default behavior of using ToolHive's built-in registry.
189190
See [Run MCP servers](./run-mcp-servers.mdx) to run an MCP server from the
190191
registry.
191192

193+
Learn how to [create a custom MCP registry](../tutorials/custom-registry.mdx).
194+
192195
## Related information
193196

194197
- [`thv registry` command reference](../reference/cli/thv_registry.md)

docs/toolhive/reference/registry-schema.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: ToolHive registry JSON schema
33
description: The JSON schema for the ToolHive registry.
4+
displayed_sidebar: toolhiveSidebar
45
---
56

67
import JSONSchemaViewer from '@theme/JSONSchemaViewer';
@@ -11,7 +12,7 @@ constraints for the registry entries, ensuring that all entries conform to a
1112
consistent format.
1213

1314
To use this schema in your own custom registry file, add a `$schema` property at
14-
the top of your JSON file, like this:
15+
the top of your JSON file:
1516

1617
```json
1718
{

docs/toolhive/tutorials/custom-registry.mdx

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ title: Create a custom MCP registry
33
description: Learn how to create a custom MCP registry for ToolHive.
44
---
55

6-
import JSONSchemaViewer from '@theme/JSONSchemaViewer';
7-
import Schema from '@site/static/api-specs/toolhive-registry-schema.json';
86
import Tabs from '@theme/Tabs';
97
import TabItem from '@theme/TabItem';
108

@@ -270,8 +268,8 @@ container registries and private servers hosted within your organization.
270268

271269
## Next steps
272270

273-
- Explore the full [schema reference](#schema-reference) below to understand all
274-
available configuration options
271+
- Explore the full [schema reference](../reference/registry-schema.mdx) to
272+
understand all available configuration options
275273
- Learn about [custom permissions](../guides-cli/custom-permissions.mdx) for
276274
fine-grained security control
277275
- Set up [secrets management](../guides-cli/secrets-management.mdx) for servers
@@ -318,21 +316,3 @@ After reverting, all registry commands
318316
[`thv registry info`](../reference/cli/thv_registry_info.md),
319317
[`thv search`](../reference/cli/thv_search.md)) will use ToolHive's built-in
320318
registry instead of your custom one.
321-
322-
## Schema reference
323-
324-
This is the JSON schema for the ToolHive registry. It defines the structure and
325-
constraints for the registry entries, ensuring that all entries conform to a
326-
consistent format.
327-
328-
To use this schema in your own custom registry file, add a `$schema` property at
329-
the top of your JSON file, like this:
330-
331-
```json
332-
{
333-
"$schema": "https://raw.githubusercontent.com/stacklok/toolhive/main/pkg/registry/data/schema.json",
334-
...
335-
}
336-
```
337-
338-
<JSONSchemaViewer schema={Schema} />

sidebars.ts

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ const sidebars: SidebarsConfig = {
1919

2020
{
2121
type: 'category',
22-
label: 'Quickstarts',
22+
label: 'Get started',
2323
description: 'Step-by-step guides to get started with ToolHive',
2424
link: {
2525
type: 'generated-index',
2626
slug: 'toolhive/quickstart',
2727
description:
28-
'Learn how to use ToolHive with these step-by-step tutorials',
28+
'Learn how to use ToolHive with these step-by-step tutorials.',
2929
},
3030
collapsed: false,
3131
items: [
@@ -129,7 +129,7 @@ const sidebars: SidebarsConfig = {
129129
type: 'generated-index',
130130
slug: 'toolhive/concepts',
131131
description:
132-
'Learn about the key concepts behind ToolHive and the Model Context Protocol (MCP)',
132+
'Learn about the key concepts behind ToolHive and the Model Context Protocol (MCP).',
133133
},
134134
items: [
135135
'toolhive/concepts/mcp-primer',
@@ -146,10 +146,17 @@ const sidebars: SidebarsConfig = {
146146
type: 'generated-index',
147147
slug: 'toolhive/tutorials',
148148
description:
149-
'Learn how to use ToolHive with these step-by-step tutorials',
149+
'Learn how to use ToolHive with these step-by-step tutorials.',
150150
},
151151
collapsed: false,
152-
items: ['toolhive/tutorials/custom-registry'],
152+
items: [
153+
{
154+
type: 'link',
155+
href: '/toolhive/quickstart',
156+
label: 'Quickstart guides',
157+
},
158+
'toolhive/tutorials/custom-registry',
159+
],
153160
},
154161

155162
'toolhive/faq',

0 commit comments

Comments
 (0)