Skip to content

Switch quickstarts to toolhive-doc-mcp server#881

Merged
danbarr merged 2 commits into
mainfrom
quickstarts-doc-mcp
May 18, 2026
Merged

Switch quickstarts to toolhive-doc-mcp server#881
danbarr merged 2 commits into
mainfrom
quickstarts-doc-mcp

Conversation

@danbarr
Copy link
Copy Markdown
Collaborator

@danbarr danbarr commented May 18, 2026

Description

Updates the CLI, UI, and Kubernetes quickstarts to use the toolhive-doc-mcp server as their example MCP server instead of fetch. The docs MCP server gives new users a natural on-ramp to discover more about ToolHive through tool calls, and each quickstart links to the hosted toolhive-doc-mcp-remote variant as an alternative to running the container locally.

While in the files, also corrected drift that had crept in:

  • Refreshed CLI sample output for thv v0.27.x: thv registry list now has a TYPE column and namespaced server names (io.github.stacklok/<name>); thv list uses GROUP / CREATED instead of TOOL TYPE / CREATED AT; thv run emits structured JSON logs.
  • Replaced the remote mcpserver_fetch.yaml reference in the K8s quickstart with an inline MCPServer manifest.
  • Fixed the K8s cleanup selector: app.kubernetes.io/name=<instance> never matched a pod (that label is always mcpserver); the correct selector is app.kubernetes.io/instance=<instance>.
  • Dropped the misleading "verifies image provenance" bullet from the CLI's "What's happening?" block; verification is opt-in via --image-verification.
  • Tightened future tense and passive voice in the prose we touched.

Validated the K8s manifest and lifecycle commands against a local kind cluster, and the CLI commands against thv v0.27.0.

Type of change

  • Documentation update

Related issues/PRs

None.

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Use toolhive-doc-mcp as the example server in the CLI, UI, and K8s
quickstarts so new users discover the docs MCP server early. Each
quickstart points readers at the hosted toolhive-doc-mcp-remote variant
as an alternative to running the container locally.

Other fixes captured along the way:

- Refresh CLI sample output for thv v0.27 (TYPE column in registry
  list, qualified io.github.stacklok/<name> names, GROUP and CREATED
  columns in thv list, JSON log format in thv run).
- Replace the K8s remote fetch YAML with an inline MCPServer manifest.
- Correct the K8s cleanup selector from app.kubernetes.io/name to
  app.kubernetes.io/instance; the former never matched any pod.
- Drop misleading provenance verification bullet; verification is
  opt-in via --image-verification.
- Tighten future tense and passive voice in prose we touched.
Copilot AI review requested due to automatic review settings May 18, 2026 14:48
@vercel
Copy link
Copy Markdown

vercel Bot commented May 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment May 18, 2026 2:59pm

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a 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 updates the ToolHive CLI, UI, and Kubernetes Operator quickstarts to use the toolhive-doc-mcp MCP server (and its hosted toolhive-doc-mcp-remote variant) as the primary example instead of the fetch server, aligning the tutorials with a “docs Q&A” onboarding flow.

Changes:

  • Swaps quickstart example prompts and explanations from web fetching to ToolHive documentation search (query_docs / get_chunk).
  • Adds “remote/hosted” guidance so readers can follow the quickstarts without running a local container (UI/CLI) and highlights MCPRemoteProxy as a Kubernetes alternative.
  • Updates Kubernetes quickstart to apply an inline MCPServer manifest and refreshes related sample outputs/commands.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/toolhive/guides-ui/quickstart.mdx Updates UI tutorial to install/use ToolHive Docs MCP server and adds a hosted-remote option.
docs/toolhive/guides-k8s/quickstart.mdx Replaces fetch example with toolhive-doc-mcp, inlines an MCPServer manifest, and updates outputs/commands accordingly.
docs/toolhive/guides-cli/quickstart.mdx Updates CLI tutorial to run toolhive-doc-mcp (and remote variant), refreshes example outputs, and adjusts prompt/explanations.

Comment thread docs/toolhive/guides-cli/quickstart.mdx Outdated
The PULLS header in thv registry list output is currently empty for
every row, so showing it with no values is confusing. Drop the column
from the example until upstream populates it.
@danbarr danbarr merged commit 5ef02bd into main May 18, 2026
6 checks passed
@danbarr danbarr deleted the quickstarts-doc-mcp branch May 18, 2026 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants