Skip to content

Conversation

@jerm-dro
Copy link
Contributor

Description

Skill for updating vMCP YAML examples in documentation, ensuring they match the canonical examples in the toolhive repository and are verified through tests.

Type of change

This is a claude skill used for automating updating documentation. I used this produce #477 without having to toil with validating the docs.

It's not perfect, and authors should still review the produced documentation. Claude has a tendency to be be more verbose or exhaustive in its documentation, which can actually harm readibility.

Skill for updating vMCP YAML examples in documentation, ensuring they
match the canonical examples in the toolhive repository and are verified
through tests.

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Copilot AI review requested due to automatic review settings January 28, 2026 23:39
@vercel
Copy link

vercel bot commented Jan 28, 2026

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

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

Request Review

Copy link
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 adds a new Claude skill definition for updating vMCP YAML examples in the docs-website repo, keeping them in sync with canonical examples in the ToolHive repo and backed by either automated or manual verification. It documents a repeatable workflow that ties documentation changes to e2e tests or manual validation and ensures the site still builds cleanly.

Changes:

  • Introduces the update-vmcp-yaml-example skill with front matter metadata and detailed step-by-step instructions.
  • Documents where vMCP-related YAML lives in both docs-website and ToolHive, including a mapping table from doc topics to canonical example files.
  • Defines verification flows (Ginkgo e2e tests vs. manual testing), build validation, and a checklist to complete when running the skill.

@jerm-dro jerm-dro enabled auto-merge (squash) January 29, 2026 20:41
@jerm-dro jerm-dro merged commit 2f97d29 into main Jan 29, 2026
9 of 11 checks passed
@jerm-dro jerm-dro deleted the jerm/2026-01-28-vmcp-yaml-skill branch January 29, 2026 22:29
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