Skip to content

Commit 957418b

Browse files
authored
Merge branch 'main' into groups
2 parents b8c489b + c8c776d commit 957418b

30 files changed

+1453
-54
lines changed

.github/workflows/update-toolhive-reference.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ jobs:
7070
title: |
7171
Update ToolHive reference docs for ${{ steps.imports.outputs.version }}
7272
body: |
73-
This PR updates the ToolHive CLI and API reference documentation to the latest release: ${{ steps.imports.outputs.version }}.
73+
This PR updates the ToolHive CLI and API reference documentation for release: ${{ steps.imports.outputs.version }}.
7474
commit-message: |
7575
Update ToolHive reference docs for ${{ steps.imports.outputs.version }}
7676
labels: |

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/cli/thv.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ thv [flags]
3939
* [thv client](thv_client.md) - Manage MCP clients
4040
* [thv config](thv_config.md) - Manage application configuration
4141
* [thv export](thv_export.md) - Export a workload's run configuration to a file
42+
* [thv group](thv_group.md) - Manage logical groupings of MCP servers
4243
* [thv inspector](thv_inspector.md) - Launches the MCP Inspector UI and connects it to the specified MCP server
4344
* [thv list](thv_list.md) - List running MCP servers
4445
* [thv logs](thv_logs.md) - Output the logs of an MCP server or manage log files

docs/toolhive/reference/cli/thv_client_register.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ thv client register [client] [flags]
3939
### Options
4040

4141
```
42-
-h, --help help for register
42+
--group strings Only register workloads from specified groups (default [default])
43+
-h, --help help for register
4344
```
4445

4546
### Options inherited from parent commands

docs/toolhive/reference/cli/thv_client_remove.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ thv client remove [client] [flags]
3939
### Options
4040

4141
```
42-
-h, --help help for remove
42+
--group strings Remove client from specified groups (if not set, removes all workloads from the client)
43+
-h, --help help for remove
4344
```
4445

4546
### Options inherited from parent commands
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: thv group
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv group`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_group
8+
mdx:
9+
format: md
10+
---
11+
12+
## thv group
13+
14+
Manage logical groupings of MCP servers
15+
16+
### Synopsis
17+
18+
The group command provides subcommands to manage logical groupings of MCP servers.
19+
20+
### Options
21+
22+
```
23+
-h, --help help for group
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
--debug Enable debug mode
30+
```
31+
32+
### SEE ALSO
33+
34+
* [thv](thv.md) - ToolHive (thv) is a lightweight, secure, and fast manager for MCP servers
35+
* [thv group create](thv_group_create.md) - Create a new group of MCP servers
36+
* [thv group list](thv_group_list.md) - List all groups
37+
* [thv group rm](thv_group_rm.md) - Remove a group and remove workloads from it
38+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: thv group create
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv group create`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_group_create
8+
mdx:
9+
format: md
10+
---
11+
12+
## thv group create
13+
14+
Create a new group of MCP servers
15+
16+
### Synopsis
17+
18+
Create a new logical group of MCP servers.
19+
The group can be used to organize and manage multiple MCP servers together.
20+
21+
```
22+
thv group create [group-name] [flags]
23+
```
24+
25+
### Options
26+
27+
```
28+
-h, --help help for create
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
--debug Enable debug mode
35+
```
36+
37+
### SEE ALSO
38+
39+
* [thv group](thv_group.md) - Manage logical groupings of MCP servers
40+
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: thv group list
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv group list`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_group_list
8+
mdx:
9+
format: md
10+
---
11+
12+
## thv group list
13+
14+
List all groups
15+
16+
### Synopsis
17+
18+
List all logical groups of MCP servers.
19+
20+
```
21+
thv group list [flags]
22+
```
23+
24+
### Options
25+
26+
```
27+
-h, --help help for list
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
--debug Enable debug mode
34+
```
35+
36+
### SEE ALSO
37+
38+
* [thv group](thv_group.md) - Manage logical groupings of MCP servers
39+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: thv group rm
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv group rm`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_group_rm
8+
mdx:
9+
format: md
10+
---
11+
12+
## thv group rm
13+
14+
Remove a group and remove workloads from it
15+
16+
### Synopsis
17+
18+
Remove a group and remove all MCP servers from it. By default, this only removes the group membership from workloads without deleting them. Use --with-workloads to also delete the workloads.
19+
20+
```
21+
thv group rm [group-name] [flags]
22+
```
23+
24+
### Options
25+
26+
```
27+
-h, --help help for rm
28+
--with-workloads Delete all workloads in the group along with the group
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
--debug Enable debug mode
35+
```
36+
37+
### SEE ALSO
38+
39+
* [thv group](thv_group.md) - Manage logical groupings of MCP servers
40+

docs/toolhive/reference/cli/thv_list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ thv list [flags]
2626
```
2727
-a, --all Show all workloads (default shows just running)
2828
--format string Output format (json, text, or mcpservers) (default "text")
29+
--group string Filter workloads by group
2930
-h, --help help for list
3031
-l, --label stringArray Filter workloads by labels (format: key=value)
3132
```

0 commit comments

Comments
 (0)