Split CLI "Run MCP servers" guide into three pages#981
Open
danbarr wants to merge 9 commits into
Open
Conversation
The run-mcp-servers guide had grown to ~1,290 lines with five top-level sections covering distinct reader journeys. Split it into three focused pages: - Run MCP servers: registry and custom (Docker/protocol) launch mechanics, plus share and reuse configurations - Run remote MCP servers: remote setup and authentication - Configure MCP servers: shared options, grouped into cross-cutting options and container-based-only options Update the CLI sidebar and repoint inbound anchored links in connect-clients and tool-optimization. No vercel redirects are added because the split only moves in-page anchors, which redirects cannot catch. Closes #937 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Audit middleware runs in the ToolHive proxy process, so audit events are written to the proxy's logs. Viewing them requires the --proxy flag on thv logs; the default command shows the MCP server container's logs, which don't include audit events. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The --secret flag injects values into the container environment, so it has no effect on remote servers. Group it with the other container-based options next to environment variables instead of listing it as a cross-cutting option with a caveat. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The box explains the core mechanics of running a registry server, so it belongs next to the local and remote run examples rather than after the groups subsection, which is an orthogonal organizational feature. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Use notion-remote in the run example so it demonstrates the suffix inline, trim the note to the convention itself, and drop the discovery tip that the registry page already covers. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Splits the previously monolithic CLI “Run MCP servers” guide into smaller, task-focused pages (remote server workflow vs. shared configuration), and updates sidebar/navigation and cross-links so readers can land directly on the right journey without wading through unrelated sections.
Changes:
- Adds two new CLI guides: Run remote MCP servers and Configure MCP servers.
- Refactors Run MCP servers to focus on registry + local/custom launch mechanics and link out to the new pages.
- Updates sidebar structure and repoints inbound links from Kubernetes/concepts docs to the new pages/anchors.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.ts | Adds the two new CLI guide pages under the “Run MCP servers” category. |
| docs/toolhive/guides-k8s/connect-clients.mdx | Updates a remote-auth cross-link to point at the new remote guide. |
| docs/toolhive/guides-cli/run-remote-mcp-servers.mdx | New page documenting remote-by-URL workflow and auth options. |
| docs/toolhive/guides-cli/run-mcp-servers.mdx | Trims/reshapes the main run guide and links out to the new pages. |
| docs/toolhive/guides-cli/configure-mcp-servers.mdx | New page extracting shared configuration flags and guidance. |
| docs/toolhive/concepts/tool-optimization.mdx | Repoints “Customize tools (CLI)” to the new canonical section/anchor. |
- Replace container-centric wording in cross-cutting config options (workload name, foreground until server stops, generic proxy target). - Mark --publish as container-only in the port section. - Note --remote-auth-client-secret-file for OIDC and OAuth2 setup. - Reword run page intro bullet so volume mounts don't imply remote servers. - Trim Next steps sections to three forward links per docs guidelines. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
6 tasks
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Align the configure guide's option grouping with the "local" vs "remote" terminology used in the UI guide and elsewhere in the CLI section (the run page already says "local containerized servers"). Keep the container explanation in the body so the reason these options skip remote servers stays clear. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Splits the CLI
Run MCP serversguide, which had grown to ~1,290 lines with five top-level sections covering distinct reader journeys, into three focused pages:The CLI sidebar gains the two new pages under the "Run MCP servers" category, and inbound anchored links in
connect-clients.mdxandtool-optimization.mdxare repointed to the new pages.No
vercel.jsonredirects are added: the split only moves in-page anchors, and the page paths themselves are unchanged. URL fragments are never sent to the server, so redirects cannot catch them.A few related fixes are folded in: the audit logging section now documents
thv logs --proxy(audit middleware runs in the proxy process, not the container), and the network isolation guidance reflects the new on-by-default behavior from the v0.30.1 update.Type of change
Related issues/PRs
Closes #937
Screenshots
Submitter checklist
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed filesReviewer checklist
Content