Split UI Run MCP servers guide into two pages#982
Merged
Conversation
Extract the per-field configuration reference out of the UI Run MCP servers guide into a new Configure MCP servers page, mirroring the CLI split in PR 981. The run page becomes a linear how-to (registry, custom local, custom remote) with no tabs, ending each flow at the configuration form. The new configure page documents every setting once, organized by options for all servers, local servers, and remote servers. This removes the 2x2 tab matrix and the duplicated remote authentication block. Update the sidebar and fix inbound anchor links in connect-clients and the filesystem guide. 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
This PR restructures the ToolHive UI “Run MCP servers” documentation by splitting the previous combined how-to/reference content into a linear how-to page plus a dedicated per-setting reference page, reducing duplication and improving navigability.
Changes:
- Refactors Run MCP servers into a linear how-to flow and links out to a new configuration reference.
- Adds a new Configure MCP servers reference page and wires it into the UI sidebar nav.
- Updates inbound links to moved anchors, removes a now-unused partial, and deletes unused icon assets.
Reviewed changes
Copilot reviewed 6 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| static/img/mcp-servers/remote-mcp.svg | Removes an unused icon asset. |
| static/img/mcp-servers/local-mcp.svg | Removes an unused icon asset. |
| sidebars.ts | Adds the new configure page under the “Run MCP servers” UI category. |
| docs/toolhive/guides-ui/run-mcp-servers.mdx | Converts the page to a linear how-to and links to the new configuration reference. |
| docs/toolhive/guides-ui/configure-mcp-servers.mdx | New reference page documenting configuration form settings and remote auth examples. |
| docs/toolhive/guides-mcp/filesystem.mdx | Repoints the storage volumes anchor link to the new configure page. |
| docs/toolhive/guides-k8s/connect-clients.mdx | Updates the UI deep link to the new “Custom remote servers” anchor. |
| docs/toolhive/_partials/_remote-mcp-auth-examples.mdx | Removes an inlined, now-unused partial. |
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
peppescg
approved these changes
Jun 26, 2026
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 ToolHive UI "Run MCP servers" guide into a how-to and a reference, mirroring the CLI split in #981.
The original page crossed two axes (registry vs. custom, local vs. remote) through nested tabs, which duplicated every field description up to four times and repeated the entire remote-auth block verbatim. This restructures it:
run-mcp-servers.mdxis now a linear how-to with no tabs: install from the registry, install a custom local server (Docker image or source package), install a custom remote server, then manage servers and upgrade image versions. Each install flow ends at the configuration form.configure-mcp-servers.mdx(new) is a per-setting reference organized into options for all servers, local servers, and remote servers, with the four authentication examples expanded into a real section (previously collapsed in a<details>).Supporting changes:
sidebars.tsto add the configure page under the Run MCP servers category.connect-clients.mdxand the filesystem MCP guide that pointed at moved anchors._remote-mcp-auth-examples.mdxpartial, and removed two orphaned icon SVGs no longer referenced after the tabs were dropped.While restructuring, corrected three accuracy issues carried over from the original:
client_secretin the web application flow, so the GitHub examples now state the secret is required, and the generic field reference notes the behavior is provider-dependent.https://mcp.bravesearch.com/sse(NXDOMAIN; Brave runs no hosted remote MCP server). Replaced with thehttps://api.example.com/mcpplaceholder convention used by the CLI guide.Note for reviewers: the run page no longer has the old tab query strings (
?server-type=,?custom-type=) or the#volumes/#remote-mcp-examplesanchors. No page slug changed, so novercel.jsonredirects are needed, but any external deep links to those in-page anchors will land on the page top.Type of change
Related issues/PRs
Screenshots
N/A
Submitter checklist
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed filesReviewer checklist
Content