Skip to content

Update VirtualMCP docs for groupRef changes - #426

Merged
jerm-dro merged 6 commits into
mainfrom
jerm/2026-01-08-update-group-ref
Jan 8, 2026
Merged

jerm-dro merged 6 commits into
mainfrom
jerm/2026-01-08-update-group-ref

Conversation

@jerm-dro

@jerm-dro jerm-dro commented Jan 8, 2026

Copy link
Copy Markdown
Contributor

Description

This change stacklok/toolhive#3205 on the toolhive side modified the shape of the virtual mcp server config.

Update VirtualMCPServer documentation to reflect the change.

Type of change

  • Documentation update

Submitter checklist

Content and formatting

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

Reviewer checklist

Content

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

Copilot AI review requested due to automatic review settings January 8, 2026 17:47
@vercel

vercel Bot commented Jan 8, 2026 •

Copy link
Copy Markdown

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

Project Deployment Review Updated (UTC)
docs-website Ready Ready Preview, Comment Jan 8, 2026 6:28pm

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 VirtualMCPServer documentation to reflect a breaking API change in the ToolHive CRD. The groupRef field has been restructured from an object with a name property to a string field nested under a new config object.

Key changes:

  • Updated API reference documentation to remove the deprecated GroupRef type and document the new config field structure
  • Updated all VirtualMCPServer YAML examples across tutorials and guides to use config.groupRef: <name> instead of groupRef.name: <name>

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
static/api-specs/toolhive-crd-api.md Removed GroupRef type definition, updated VirtualMCPServerSpec to document new config field with groupRef string, added endpointPrefix field documentation
docs/toolhive/tutorials/quickstart-vmcp.mdx Updated VirtualMCPServer example to use config.groupRef structure
docs/toolhive/guides-vmcp/tool-aggregation.mdx Updated VirtualMCPServer example to use config.groupRef structure
docs/toolhive/guides-vmcp/configuration.mdx Updated VirtualMCPServer example to use config.groupRef structure
docs/toolhive/guides-vmcp/composite-tools.mdx Updated two VirtualMCPServer examples to use config.groupRef structure
package-lock.json Automated npm change adding peer flag to styled-components (unrelated maintenance)

Comment thread static/api-specs/toolhive-crd-api.md Outdated
Comment thread static/api-specs/toolhive-crd-api.md Outdated
Comment thread static/api-specs/toolhive-crd-api.md
@jerm-dro
jerm-dro merged commit fd85404 into main Jan 8, 2026
8 checks passed
@jerm-dro
jerm-dro deleted the jerm/2026-01-08-update-group-ref branch January 8, 2026 18:35

This branch was successfully deployed

1 active deployment
Preview — aafd11b1 Deployed Jan 8, 2026 by vercel[bot]
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