Skip to content

Commit 9ab6247

Browse files
authored
Clarify ToolHive onboarding and navigation (#800)
* Clarify ToolHive platform overview * Refine docs navigation * Tighten onboarding quickstarts * Strengthen platform positioning * Address review feedback * Polish onboarding copy * Rename platform capabilities section * Shorten reference nav labels * Add authorization policies doc card --------- Co-authored-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
1 parent 395bfdc commit 9ab6247

20 files changed

Lines changed: 309 additions & 154 deletions

File tree

.agents/skills

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../.claude/skills

docs/toolhive/guides-cli/index.mdx

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,19 @@ import DocCardList from '@theme/DocCardList';
99

1010
## Introduction
1111

12-
The ToolHive CLI (`thv`) is a command-line tool that allows you to deploy and
13-
manage MCP servers on your local machine or in development environments. It
14-
provides quick deployment of MCP servers and supports advanced features like
15-
custom permissions, network access filtering, and telemetry.
12+
The ToolHive CLI (`thv`) gives you a fast, repeatable way to run and manage MCP
13+
servers from the terminal. Use it when you want to script server setup, control
14+
permissions precisely, work in development environments, or automate ToolHive
15+
workflows in shell scripts and CI.
1616

17-
It's designed for developers who prefer working in a terminal or need to
18-
integrate MCP server management into scripts or automation workflows.
17+
Within the ToolHive platform, the CLI gives you direct access to the same local
18+
runtime, built-in registry, and client-configuration workflows that power the
19+
UI. If you want a terminal-first way to run ToolHive locally or embed it in
20+
automation, start here.
21+
22+
The CLI can also connect your local workflows and AI clients to the broader
23+
ToolHive platform. You can use it with MCP servers or gateways managed by the
24+
Kubernetes Operator, and point local workflows at a ToolHive Registry Server.
1925

2026
:::info[Using ToolHive UI?]
2127

@@ -32,6 +38,8 @@ both installed.
3238
`thv` and run your first MCP server in minutes.
3339
- **Already installed?** Jump to [Run MCP servers](./run-mcp-servers.mdx) to
3440
start managing servers from the command line.
41+
- **Want to browse the default catalog?** See
42+
[Use the registry](./registry.mdx).
3543
- **Managing agent skills?** See [Manage agent skills](./skills-management.mdx)
3644
to install and publish reusable skills.
3745
- **Building or automating?** See advanced workflows for [auth](./auth.mdx),

docs/toolhive/guides-cli/install.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ To uninstall ToolHive:
389389
## Next steps
390390

391391
Now that you have ToolHive installed, you can start using it to run and manage
392-
MCP servers. See [Explore the registry](./registry.mdx) and
392+
MCP servers. See [Use the registry](./registry.mdx) and
393393
[Run MCP servers](./run-mcp-servers.mdx) to get started.
394394

395395
## Related information

docs/toolhive/guides-cli/quickstart.mdx

Lines changed: 54 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ Before starting this tutorial, make sure you have:
2525
- [Docker](https://docs.docker.com/get-docker/) or
2626
[Podman](https://podman-desktop.io/downloads) or
2727
[Colima](https://github.com/abiosoft/colima) installed and running
28-
- A [supported MCP client](../reference/client-compatibility.mdx) like GitHub
29-
Copilot in VS Code, Cursor, Claude Code, and more
28+
- _(Optional)_ A [supported MCP client](../reference/client-compatibility.mdx)
29+
such as GitHub Copilot in VS Code, Cursor, or Claude Code. Needed only if you
30+
want to test end-to-end client integration.
3031

3132
## Step 1: Install ToolHive
3233

@@ -92,44 +93,7 @@ Platform: darwin/arm64
9293

9394
This confirms ToolHive is installed and ready to use.
9495

95-
## Step 2: Register your client
96-
97-
Next, run the ToolHive client setup command to register your MCP client:
98-
99-
```bash
100-
thv client setup
101-
```
102-
103-
Select one or more clients from the list using the spacebar to toggle selection.
104-
Press Enter to confirm your selection.
105-
106-
:::info[What's happening?]
107-
108-
When you run the setup command, ToolHive automatically finds
109-
[supported clients](../reference/client-compatibility.mdx) on your system. When
110-
you register a client, ToolHive automatically configures it to use MCP servers
111-
that you run. This means you don't have to manually configure the client to
112-
connect to the MCP server.
113-
114-
:::
115-
116-
Confirm that your client is registered successfully:
117-
118-
```bash
119-
thv client status
120-
```
121-
122-
You should see output similar to this:
123-
124-
```text
125-
┌────────────────┬───────────┬────────────┐
126-
│ CLIENT TYPE │ INSTALLED │ REGISTERED │
127-
├────────────────┼───────────┼────────────┤
128-
│ vscode │ ✅ Yes │ ❌ No │
129-
└────────────────┴───────────┴────────────┘
130-
```
131-
132-
## Step 3: Find an MCP server to run
96+
## Step 2: Find an MCP server to run
13397

13498
See what MCP servers are available in the registry:
13599

@@ -153,8 +117,8 @@ This shows all the MCP servers available in the ToolHive registry.
153117
:::info[What's happening?]
154118

155119
ToolHive maintains a curated registry of MCP servers that have been verified to
156-
work correctly. The registry includes information about what each server does
157-
and how to use it.
120+
work correctly. This built-in registry is the default catalog that the CLI uses
121+
to help you find and launch servers.
158122

159123
:::
160124

@@ -169,7 +133,7 @@ thv registry info fetch
169133
This shows you detailed information about the server, including what tools it
170134
provides and any configuration options.
171135

172-
## Step 4: Run the Fetch MCP server
136+
## Step 3: Run the Fetch MCP server
173137

174138
Now, run the Fetch server:
175139

@@ -208,7 +172,7 @@ When you run an MCP server, ToolHive:
208172

209173
:::
210174

211-
## Step 5: Verify the server is running
175+
## Step 4: Verify the server is running
212176

213177
Check that the server is running:
214178

@@ -233,9 +197,46 @@ running and how they're configured.
233197

234198
:::
235199

200+
## Step 5: Connect an AI client
201+
202+
To see the full payoff of the tutorial, have ToolHive configure a supported MCP
203+
client for you now:
204+
205+
```bash
206+
thv client setup
207+
```
208+
209+
Select one or more clients from the list using the spacebar to toggle selection.
210+
Press Enter to confirm your selection.
211+
212+
Confirm that your client is registered successfully:
213+
214+
```bash
215+
thv client status
216+
```
217+
218+
You should see output similar to this:
219+
220+
```text
221+
┌────────────────┬───────────┬────────────┐
222+
│ CLIENT TYPE │ INSTALLED │ REGISTERED │
223+
├────────────────┼───────────┼────────────┤
224+
│ vscode │ ✅ Yes │ ✅ Yes │
225+
└────────────────┴───────────┴────────────┘
226+
```
227+
228+
:::info[What's happening?]
229+
230+
When you run the setup command, ToolHive automatically finds
231+
[supported clients](../reference/client-compatibility.mdx) on your system. When
232+
you register a client, ToolHive automatically configures it to use MCP servers
233+
that you run.
234+
235+
:::
236+
236237
## Step 6: Use the MCP server with your AI client
237238

238-
Now that your MCP server is running, you can use it with your AI client
239+
If you completed Step 5, you can now use the MCP server with your AI client
239240
application. Open your supported client (VS Code, Cursor, etc.) and ask the AI
240241
to fetch content from a website. Note that you might need to restart your client
241242
for the changes to take effect.
@@ -279,12 +280,12 @@ the container, freeing up resources.
279280

280281
:::
281282

282-
## What's next?
283+
## Next steps
283284

284285
Congratulations! You've successfully installed ToolHive and run your first MCP
285286
server. Here are some next steps to explore:
286287

287-
- Try running other MCP servers from the registry with
288+
- Try running other MCP servers from the built-in registry with
288289
[`thv registry list`](../reference/cli/thv_registry_list.md) and
289290
[`thv run`](../reference/cli/thv_run.md)
290291
- Learn about [secrets management](../guides-cli/secrets-management.mdx) for MCP
@@ -309,6 +310,11 @@ production-ready MCP servers, that's where Stacklok Enterprise comes in.
309310

310311
:::
311312

313+
## Related information
314+
315+
- [Use the registry](../guides-cli/registry.mdx)
316+
- [Client compatibility](../reference/client-compatibility.mdx)
317+
312318
## Troubleshooting
313319

314320
<details>
@@ -333,7 +339,7 @@ thv run --proxy-port 8081 fetch
333339

334340
If your AI client application can't use the server:
335341

336-
- Make sure your client is registered with ToolHive (see Step 2)
342+
- Make sure your client is registered with ToolHive (see Step 5)
337343
- Check that your client is supported
338344
- Restart your client to pick up the new configuration
339345
- Verify the server is running with [`thv list`](../reference/cli/thv_list.md)

docs/toolhive/guides-cli/registry.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Explore the registry
2+
title: Use the registry
33
description:
44
Search the built-in registry to find, inspect, and run MCP servers with one
55
command.

docs/toolhive/guides-k8s/index.mdx

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,16 @@ import DocCardList from '@theme/DocCardList';
99

1010
## Introduction
1111

12-
The ToolHive Kubernetes Operator manages MCP servers in Kubernetes clusters. You
13-
define MCP servers as Kubernetes custom resources and the operator automates
12+
The ToolHive Kubernetes Operator brings MCP servers into a shared, governable
13+
Kubernetes environment. It solves the gap between trying MCP locally and running
14+
it for teams, with standard deployment workflows, centralized policy control,
15+
and platform-managed connectivity.
16+
17+
Within the ToolHive platform, the operator is the foundation for multi-user and
18+
production-style deployments. It runs MCP workloads in the cluster and unlocks
19+
capabilities like Virtual MCP Server (vMCP) and Registry Server integrations.
20+
21+
You define MCP servers as Kubernetes custom resources and the operator automates
1422
their deployment, proxying, and lifecycle management. The operator supports
1523
several primary resource types:
1624

@@ -21,10 +29,8 @@ several primary resource types:
2129
- **VirtualMCPServer**: aggregate and optimize multiple servers behind a single
2230
endpoint
2331

24-
Beyond managing MCP servers, the operator can deploy
25-
[ToolHive Registry Server](../guides-registry/index.mdx) instances via
26-
MCPRegistry resources, enabling automatic discovery of cluster-hosted MCP
27-
servers.
32+
This is the best starting point when you need ToolHive in a shared, multi-user,
33+
or production-style Kubernetes environment.
2834

2935
## Where to start
3036

docs/toolhive/guides-k8s/quickstart.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ This will fully remove the kind cluster and clean up all associated resources.
426426

427427
:::
428428

429-
## What's next?
429+
## Next steps
430430

431431
Congratulations! You've successfully deployed the ToolHive operator and created
432432
your first MCP server using Kubernetes resources. You now have a working
@@ -454,6 +454,11 @@ support - built for teams taking MCP from proof of concept to production.
454454

455455
:::
456456

457+
## Related information
458+
459+
- [Connect clients to MCP servers](../guides-k8s/connect-clients.mdx)
460+
- [Run MCP servers in Kubernetes](../guides-k8s/run-mcp-k8s.mdx)
461+
457462
## Troubleshooting
458463

459464
<details>

docs/toolhive/guides-registry/index.mdx

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,28 @@ import DocCardList from '@theme/DocCardList';
99

1010
## Introduction
1111

12-
The ToolHive Registry Server is an implementation of the official
13-
[Model Context Protocol (MCP) Registry API specification](https://github.com/modelcontextprotocol/registry/blob/main/docs/reference/api/generic-registry-api.md).
14-
It provides a standardized REST API for discovering and accessing MCP servers
15-
from multiple backend sources, including Kubernetes clusters, Git repositories,
16-
API endpoints, and local files.
12+
The ToolHive Registry Server helps you publish and govern a catalog of MCP
13+
servers or skills for your team. Use it when you want a trusted catalog that
14+
improves discoverability, supports publishing workflows, and gives you more
15+
control over what different users can access.
16+
17+
It can aggregate entries from Kubernetes clusters, Git repositories, API
18+
endpoints, and local files, then expose them through a standard MCP Registry API
19+
for ToolHive and other clients.
1720

1821
:::note
1922

2023
This section covers the **Registry Server**, a standalone service you deploy
2124
yourself. Looking for the built-in registry instead? See
22-
[Explore the registry](../guides-cli/registry.mdx) (CLI) or
23-
[Explore the registry](../guides-ui/registry.mdx) (UI).
25+
[Use the registry](../guides-cli/registry.mdx) (CLI) or
26+
[Use the registry](../guides-ui/registry.mdx) (UI).
2427

2528
:::
2629

30+
If you want to host and operate your own catalog, use the Registry Server. If
31+
you only need to browse the default ToolHive catalog from the UI or CLI, you do
32+
not need to deploy it.
33+
2734
## Where to start
2835

2936
- **New to the Registry Server?** Follow the

docs/toolhive/guides-registry/intro.mdx

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,37 @@ description:
55
Server
66
---
77

8-
The ToolHive Registry Server is a standards-compliant implementation of the MCP
9-
Registry API specification. It provides a REST API for discovering and accessing
10-
MCP servers from multiple backend sources.
8+
The ToolHive Registry Server gives you a way to publish, curate, and control a
9+
catalog of MCP servers and skills for your organization. Use it when you want a
10+
trusted catalog for discoverability, team-scoped access, publishing, or
11+
multi-source aggregation.
12+
13+
It pulls entries from multiple sources, stores them centrally, and exposes them
14+
through a standard MCP Registry API that ToolHive and other clients can consume.
1115

1216
:::note[Registry Server vs. built-in registry]
1317

14-
This section covers the **Registry Server**, a standalone service you deploy
15-
yourself for hosting and curating your own MCP server catalog.
18+
This section covers the **Registry Server** for hosting and curating your own
19+
MCP server and skills catalog.
1620

1721
ToolHive also ships with a **built-in registry** for browsing and discovering
1822
MCP servers from the default catalog. That's a different feature: see
19-
[Explore the registry](../guides-cli/registry.mdx) (CLI) or
20-
[Explore the registry](../guides-ui/registry.mdx) (UI).
23+
[Use the registry](../guides-cli/registry.mdx) (CLI) or
24+
[Use the registry](../guides-ui/registry.mdx) (UI).
2125

2226
:::
2327

28+
## Why use the Registry Server?
29+
30+
Use the Registry Server when you need to:
31+
32+
- Curate a private or team-specific catalog instead of relying only on the
33+
default public catalog
34+
- Publish MCP servers or [skills](../concepts/skills.mdx) for internal use
35+
- Aggregate entries from multiple sources behind one registry API
36+
- Apply authentication and authorization policies to registry access
37+
- Surface cluster-hosted workloads to users through a managed catalog
38+
2439
## Key concepts
2540

2641
The Registry Server is built around three core concepts:
@@ -38,8 +53,9 @@ The Registry Server is built around three core concepts:
3853

3954
## How the Registry Server works
4055

41-
The Registry server aggregates MCP server metadata from various sources and
42-
exposes it through a standardized API. When you start the server, it:
56+
The Registry Server aggregates MCP server and skills metadata from various
57+
sources and exposes it through a standardized API. When you start the server,
58+
it:
4359

4460
1. Loads configuration from a YAML file
4561
2. Runs database migrations automatically
@@ -129,9 +145,9 @@ The server supports five source types:
129145

130146
## Registry Server and the rest of ToolHive
131147

132-
The Registry Server is a standalone service. It is separate from the built-in
133-
catalog that the ToolHive CLI and UI ship with for browsing public MCP servers.
134-
The pieces work together:
148+
The Registry Server is one part of the broader ToolHive platform. It is
149+
different from the built-in catalog that the ToolHive CLI and UI ship with for
150+
browsing public MCP servers, but the pieces work together:
135151

136152
- The CLI's [`thv search`](../reference/cli/thv_search.md) and
137153
[`thv registry`](../guides-cli/registry.mdx) commands query the built-in

0 commit comments

Comments
 (0)