Skip to content

Commit b969f4f

Browse files
danbarrclaude
andauthored
Remove registry groups from documentation (#938)
Registry groups are deprecated and no longer surfaced by the CLI or UI with the upstream registry format. Remove the registry-groups sections from the CLI and UI registry guides and drop groups references from the registry schema reference. The runtime-groups content nested under the CLI registry-groups section is already covered by the group management guide and run-mcp-servers, so remove it here and point to group management from Next steps instead. Closes #815. Co-authored-by: Dan Barr <6922515+danbarr@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 81a1a01 commit b969f4f

3 files changed

Lines changed: 12 additions & 134 deletions

File tree

docs/toolhive/guides-cli/registry.mdx

Lines changed: 3 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -234,91 +234,14 @@ thv config unset-registry
234234

235235
This restores the default behavior of using ToolHive's built-in registry.
236236

237-
## Organize servers with registry groups
238-
239-
Registry groups allow you to organize related MCP servers and run them together
240-
as a cohesive unit. This is particularly useful for creating team-specific
241-
toolkits, workflow-based server collections, or environment-specific
242-
configurations.
243-
244-
:::note
245-
246-
Registry groups are different from [runtime groups](./group-management.mdx).
247-
Registry groups organize server definitions within registry files, while runtime
248-
groups organize running server instances for access control.
249-
250-
:::
251-
252-
### Group structure
253-
254-
Groups are defined under `data.groups` in your custom registry. Each group has a
255-
name, description, and an array of servers:
256-
257-
```json
258-
{
259-
"data": {
260-
"servers": [
261-
// Individual servers
262-
],
263-
"groups": [
264-
{
265-
"name": "group-name",
266-
"description": "Description of what this group provides",
267-
"servers": [
268-
// Complete server definitions
269-
]
270-
}
271-
]
272-
}
273-
}
274-
```
275-
276-
See the [registry schema](../reference/registry-schema-upstream.mdx) for the
277-
full server object structure.
278-
279-
### Key characteristics
280-
281-
- **Optional**: Groups are entirely optional. Omit the `groups` section if you
282-
only need individual servers
283-
- **Independent server definitions**: Each group contains complete server
284-
configurations, not references to top-level servers
285-
- **Self-contained**: Groups can define servers with the same names as top-level
286-
servers but with different configurations
287-
- **Flexible membership**: The same server can appear in multiple groups with
288-
different configurations
289-
290-
### Full example
291-
292-
For a complete custom registry file with both top-level servers and groups, see
293-
the [Full example](../reference/registry-schema-upstream.mdx#full-example) in
294-
the registry schema reference.
295-
296-
### Use registry servers with groups
297-
298-
You can organize registry servers into runtime groups after running them:
299-
300-
```bash
301-
thv group create dev-toolkit
302-
thv run --group dev-toolkit github
303-
thv run --group dev-toolkit heroku
304-
```
305-
306-
You can pass environment variables and secrets to each server individually:
307-
308-
```bash
309-
thv run --group dev-toolkit --secret github-token,target=GITHUB_PERSONAL_ACCESS_TOKEN github
310-
thv run --group dev-toolkit --secret heroku-key,target=HEROKU_API_KEY heroku
311-
```
312-
313-
Groups provide a convenient way to start multiple related servers with a single
314-
command. See [Group management](./group-management.mdx) for more details on
315-
creating and managing groups.
316-
317237
## Next steps
318238

319239
See [Run MCP servers](./run-mcp-servers.mdx) to run an MCP server from the
320240
registry.
321241

242+
Learn how to [organize servers into groups](./group-management.mdx) to manage
243+
related servers together.
244+
322245
Learn how to [create a custom MCP registry](../tutorials/custom-registry.mdx).
323246

324247
## Related information

docs/toolhive/guides-ui/registry.mdx

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -54,49 +54,6 @@ Click on any server in the registry to view detailed information including:
5454
This detailed view helps you understand the server's purpose and capabilities
5555
before adding it to your ToolHive installation.
5656

57-
## Registry groups
58-
59-
Registry groups allow you to organize related MCP servers and run them together
60-
as a cohesive unit. This is particularly useful for creating team-specific
61-
toolkits, workflow-based server collections, or environment-specific
62-
configurations.
63-
64-
The default ToolHive registry contains only individual servers. To use groups,
65-
configure a [custom registry](../tutorials/custom-registry.mdx) that defines
66-
them.
67-
68-
### Key characteristics
69-
70-
- **Optional**: Groups are entirely optional. You only need a custom registry
71-
with groups if you want to install multiple servers together
72-
- **Independent server definitions**: Each group contains complete server
73-
configurations, not references to top-level servers
74-
- **Self-contained**: Groups can define servers with the same names as
75-
individual servers but with different configurations
76-
- **Flexible membership**: The same server can appear in multiple groups with
77-
different configurations
78-
79-
### Browse and view groups
80-
81-
When you use a custom registry that includes groups, they appear in the registry
82-
grid alongside individual servers. Click on any group to view its name,
83-
description, and a list of all included servers with their descriptions. From
84-
the group details page, you can click **Install group** to begin installation.
85-
86-
### Install a group
87-
88-
To install a group:
89-
90-
1. Click **Install group** to open the wizard
91-
2. Configure each server following the same process as
92-
[installing an individual server](./run-mcp-servers.mdx#configure-the-server)
93-
3. Click **Next** after each server, or **Finish** on the last one
94-
95-
The wizard guides you through each server one at a time, showing your progress
96-
(for example, "Installing server 1 of 3"). After installation, the group appears
97-
in the **MCP Servers** page where you can
98-
[manage the servers together](./group-management.mdx).
99-
10057
## Registry settings
10158

10259
To configure your registry, ToolHive provides a dedicated **Registry** settings

docs/toolhive/reference/registry-schema-upstream.mdx

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
title: Registry JSON schema
33
description:
44
JSON schema reference for the ToolHive registry format, which builds on the
5-
official MCP server schema and adds skills, groups, and publisher-provided
6-
metadata.
5+
official MCP server schema and adds skills and publisher-provided metadata.
76
displayed_sidebar: toolhiveSidebar
87
---
98

@@ -14,15 +13,14 @@ import PublisherProvidedSchema from '@site/static/api-specs/publisher-provided.s
1413
import SkillSchema from '@site/static/api-specs/skill.schema.json';
1514

1615
This is the ToolHive registry schema, built on the official MCP server schema
17-
with ToolHive-specific additions for skills, groups, and publisher-provided
18-
metadata. It defines the structure and constraints for registry entries,
19-
ensuring that all entries conform to a consistent format.
20-
21-
The top-level `data` object holds three arrays: `servers` (objects conforming to
22-
the official MCP server schema), `skills` (objects conforming to the ToolHive
23-
skill schema, documented below), and `groups` (optional groupings). The schema
24-
requires `servers` to be present even when empty, so a skills-only file still
25-
needs `"servers": []`.
16+
with ToolHive-specific additions for skills and publisher-provided metadata. It
17+
defines the structure and constraints for registry entries, ensuring that all
18+
entries conform to a consistent format.
19+
20+
The top-level `data` object holds two arrays: `servers` (objects conforming to
21+
the official MCP server schema) and `skills` (objects conforming to the ToolHive
22+
skill schema, documented below). The schema requires `servers` to be present
23+
even when empty, so a skills-only file still needs `"servers": []`.
2624

2725
:::info
2826

0 commit comments

Comments
 (0)