-
Notifications
You must be signed in to change notification settings - Fork 2
Add documentation for groups #124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive documentation for the new groups feature in ToolHive, which allows users to organize MCP servers into logical collections and control client access to specific server groups.
- Creates a new guide explaining group concepts, creation, and management
- Updates existing guides to incorporate group-related commands and options
- Adds the new documentation page to the sidebar navigation
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.ts | Adds the new group management guide to the CLI guides section |
| docs/toolhive/guides-cli/run-mcp-servers.mdx | Documents the --group option for running servers within specific groups |
| docs/toolhive/guides-cli/manage-mcp-servers.md | Adds group-based operations for stop, restart, and remove commands |
| docs/toolhive/guides-cli/group-management.md | New comprehensive guide covering group creation, server organization, and client access configuration |
| docs/toolhive/guides-cli/client-configuration.mdx | Documents group-specific client registration and removal options |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I can't see why Vercel is failing, but my guess is that it's an invalid link which will be fixed once we release and have the |
|
@eleftherias Yeah it's the broken link. To get a clean preview, you could copy over the docs/cli directory from the toolhive repo into your PR (or just the ones you need) and we can rebase/merge with the automatic PR once the release is cut. |
danbarr
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made a few minor inline suggestions. Some other thoughts:
-
Probably worth mentioning somewhere that a server can only be part of a single group, that if you want the same MCP server available in multiple groups, you need to run multiple instances?
-
Optional, but I wonder if a simple mermaid diagram in the group management guide might be useful to help illustrate the structure?
|
Thanks for feedback, I added a new section for the same MCP server in multiple groups. |
Description
Document the new groups feature.
Related issues/PRs
stacklok/toolhive#1460
Merge checklist
Content
sidebars.ts) updated for added, deleted, reordered, or renamed filesvercel.jsonfor moved, renamed, or deleted pages (i.e., if the URL slug changed)Reviews