Conversation
Adds an Upgrade registry image versions subsection to the UI run-mcp-servers guide and a Drift and registry mismatches section to the customize-tools guide. Closes #766. Co-authored-by: Cursor <cursoragent@cursor.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Documents how ToolHive surfaces registry upgrade availability and drift/mismatch states for MCP servers in the UI, filling the gap described in issue #766.
Changes:
- Adds an Upgrade registry image versions subsection to the MCP servers guide, documenting when and how the upgrade action appears and what the update dialog shows.
- Adds a Drift and registry mismatches section to the customize tools guide, describing tag drift and tool-list mismatch alerts.
- Cross-links the two guides to help users navigate between upgrade and drift troubleshooting.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/toolhive/guides-ui/run-mcp-servers.mdx | Documents the registry image upgrade affordance and the update dialog outcomes, plus a cross-link to drift details. |
| docs/toolhive/guides-ui/customize-tools.mdx | Documents drift/mismatch alerts shown on Customize tools and links back to the registry image upgrade steps. |
| When an upgrade is available, the server card shows an amber upgrade button next | ||
| to the server name. The button label reads `Update to <TAG>`, where `<TAG>` is | ||
| the new registry tag, and its tooltip reads | ||
| `Update available: <LOCAL_TAG> → <REGISTRY_TAG>` so you can see exactly what's | ||
| changing. The same action appears in the menu (︙) as `Update to <TAG>`. | ||
| ToolHive disables the menu item while the server is being deleted, removed, or | ||
| updated. |
| upgrade affordance on the server card when a newer image tag is available. The | ||
| affordance only appears when all of the following are true: |
danbarr
left a comment
danbarr
left a comment
There was a problem hiding this comment.
Solid coverage of the upgrade and drift flows, and the cross-link between the two new sections is well-placed. Findings below; Copilot's two comments are addressed inline at the bottom.
Primary issues
1. Inconsistent code-vs-bold formatting for UI strings
The new content wraps UI alert/dialog strings in backticks: Update to <TAG> (line 543), Update available: <LOCAL_TAG> → <REGISTRY_TAG> (line 545), No configuration changes detected between versions. (line 555), New variables in this version: (line 561), Variables no longer in registry: (line 564), and Missing from server: in customize-tools.mdx. But the same PR uses bold for **Update to latest version**, **Edit and review**, **Update**, **Cancel**, etc. The project style guide reserves inline code for code elements (variable names, flags) and uses bold for UI elements. The longer alert messages are already in blockquotes, which works well; the short labels and dialog text should be bold instead of code. The secret / env / required badges are arguably token-like and could stay as code.
Ask: Move UI strings from code to bold. Keep blockquotes for the multi-sentence alert text.
2. Verify the upgrade button placement and label
Copilot's first comment claims that in v0.30.0 the card-level upgrade control is an icon button next to start/stop actions, and that the Update to <TAG> text only appears in the overflow menu, not as a labeled button next to the server name as the doc currently describes (line 543). I can't verify this from outside the toolhive-studio repo, but it's worth a second look since you've already checked the strings against the source. Specifically: is the card control icon-only or does it have a visible text label? And is the "next to the server name" placement accurate?
Ask: Re-check the card control's render against v0.30.0 source and adjust placement/label wording if needed.
Secondary issues
| Issue | Recommendation |
|---|---|
| "Upgrade affordance" (lines 535, 539) is UX jargon | Replace with "upgrade option" or "upgrade button"; concur with Copilot's second comment. |
| "Amber upgrade button" (line 542) leans on color, which is inaccessible for color-blind readers and may vary across themes | Describe the button by location or label rather than color, or pair color with a non-color cue. |
| "ToolHive disables the menu item while the server is being deleted, removed, or updated" (line 548): "deleted" and "removed" appear to be the same action, and the menu item is Remove | Consolidate to "while the server is being removed or updated." |
| "remote URL install" (line 537) doesn't match terminology used elsewhere on the page ("remote MCP server") | Use the existing terminology for consistency. |
| The Configuration drift bullet (lines 559-568) is one dense paragraph mixing description, badges, and three user actions; the sibling No configuration drift bullet is one short sentence | Break out the action steps from the description so the two bullets read more symmetrically. |
Re: Copilot's comments
- Button placement (line 550): Flagged as primary issue 2 above. Worth verifying.
- "Upgrade affordance" jargon (line 538): Concur. Captured in secondary issues.
Address Copilot feedback on #851: distinguish the icon upgrade button on the card from the kebab menu item, and replace "upgrade affordance" with plain language. Co-authored-by: Cursor <cursoragent@cursor.com>
Address danbarr's CHANGES_REQUESTED review on #851: rephrase the upgrade controls description, drop "affordance" jargon, switch short UI labels to bold and longer dialog/toast copy to blockquotes, align remote-server terminology, and tighten the configuration-drift flow. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Thanks for the review. Pushed updates as
A couple of judgment calls:
|
danbarr
left a comment
danbarr
left a comment
There was a problem hiding this comment.
All review feedback addressed cleanly: terminology fixed ("upgrade option", "remote MCP server"), color descriptor dropped, button placement now matches the v0.30.0 UI (icon control next to start/stop, text label in the overflow menu), Configuration drift bullet split into a readable lead + sub-actions, and UI strings now use bold + blockquote instead of inline code. Customize tools change is good too.
Description
Closes #766.
Summary
run-mcp-servers.mdx, covering when the upgrade affordance appears (local + registry image + tag mismatch), the card button and kebab menu, and the Update to latest version dialog (with and without env-var drift).customize-tools.mdxdocumenting the Tag drift detected and Tools differ from registry alerts and cross-linking back to the upgrade subsection.stacklok/toolhive-studioat tagv0.30.0.Test plan
npm run buildpassesType of change
Related issues/PRs
Closes #766
Submitter checklist
Content and formatting
Made with Cursor