update-vmcp-yaml-example

Update VirtualMCPServer YAML documentation examples and validate against ToolHive configurations.

4|3|Updated Jun 5, 2025
One-click install
npx skills add https://github.com/stacklok/docs-website --skill update-vmcp-yaml-example
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-vmcp-yaml-example
Source: https://github.com/stacklok/docs-website/tree/main/.claude/skills/update-vmcp-yaml-example
Command: npx skills add https://github.com/stacklok/docs-website --skill update-vmcp-yaml-example

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents outdated or inconsistent VirtualMCPServer YAML documentation by synchronizing examples with canonical ToolHive configurations and validating documented behavior.

Core Features & Use Cases

  • Documentation Synchronization: Updates vMCP YAML examples in docs-website to match source-of-truth examples from the ToolHive repository.
  • Verification Workflows: Guides creation of Ginkgo end-to-end tests or manual validation steps for documented vMCP features.
  • Use Case: When a vMCP configuration feature changes, use this Skill to update documentation examples, verify the deployment behavior, and ensure the docs build successfully.

Quick Start

Use the update-vmcp-yaml-example skill to update the VirtualMCPServer YAML examples in the documentation and verify them against the latest ToolHive examples.

Frequently Asked Questions about update-vmcp-yaml-example

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep vMCP YAML documentation examples synchronized with ToolHive configurations?

To keep vMCP YAML documentation accurate, you can use a dedicated workflow to pull canonical configurations from the ToolHive repository and update the examples in the docs-website to match the source-of-truth.

How do I validate vMCP YAML configuration changes after updating documentation?

To validate vMCP YAML configuration changes, you can run Ginkgo end-to-end tests or follow manual validation steps to verify documented deployment behavior and ensure the examples function as expected.

What is the best way to verify that updated vMCP documentation builds successfully without formatting issues?

The best way to verify vMCP documentation builds successfully is to run build checks and formatting compliance validation after updating the YAML examples, ensuring reliable and correctly formatted published documentation.

Do I need Ginkgo to test vMCP YAML configuration examples?

Ginkgo is recommended for creating end-to-end tests to verify vMCP YAML configuration behavior, but manual validation steps can also be followed to test the documented deployment workflows if needed.

Why does my vMCP documentation show outdated VirtualMCPServer YAML examples?

vMCP documentation shows outdated YAML examples when they are not synchronized with the canonical ToolHive repository configurations, requiring a documentation update and verification workflow to restore accuracy.

Can I update vMCP YAML examples without running end-to-end verification tests?

You can update vMCP YAML examples without tests, but running Ginkgo end-to-end verification or manual validation is required to ensure the documented deployment behavior remains accurate and reliable.