Skip to content

Fix YAML docs#3070

Merged
jerm-dro merged 1 commit intomainfrom
jerm/2025-12-16-fix-docs
Dec 16, 2025
Merged

Fix YAML docs#3070
jerm-dro merged 1 commit intomainfrom
jerm/2025-12-16-fix-docs

Conversation

@jerm-dro
Copy link
Copy Markdown
Contributor

Summary

Fix documentation to use correct YAML field naming conventions.

@jhrozek identified this issue on this PR #3006.

Problem

The composite tools documentation was using incorrect YAML field names that didn't match the actual API implementations. This caused confusion because:

  1. type: tool_call was used in docs, but the actual valid value is type: tool (per WorkflowStep.Type enum in the CRD)

  2. on_error: (snake_case) was used in Kubernetes CRD examples, but the actual JSON field name is onError: (camelCase)

Root Cause

ToolHive has two different configuration formats with different yaml conventions.

Example: CRD vs rawConfig

Documentation examples were inconsistently mixing these conventions, particularly in docs/operator/ which documents the Kubernetes CRDs but was using snake_case field names from the CLI format.

In the long term, we should simplify are configuration system, but in the meantime make the docs reflect reality.

Changes

docs/operator/virtualmcpcompositetooldefinition-guide.md

  • Fixed type: tool_calltype: tool
  • Fixed section heading #### tool_call (Phase 1)#### tool (Phase 1)
  • Fixed validation text to reference tool instead of tool_call

docs/operator/composite-tools-quick-reference.md

  • Fixed on_error:onError:

docs/operator/advanced-workflow-patterns.md

  • Fixed on_error:onError:

docs/proposals/THV-2106-virtual-mcp-server.md

  • Fixed on_error:onError: - in K8s CRD section only

Signed-off-by: Jeremy Drouillard <jeremy@stacklok.com>
@jerm-dro jerm-dro requested a review from jhrozek December 16, 2025 17:57
@jerm-dro jerm-dro changed the title doc improvements Fix YAML docs Dec 16, 2025
@github-actions github-actions bot added the size/XS Extra small PR: < 100 lines changed label Dec 16, 2025
@codecov
Copy link
Copy Markdown

codecov bot commented Dec 16, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.85%. Comparing base (d265b0b) to head (e233789).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3070   +/-   ##
=======================================
  Coverage   56.85%   56.85%           
=======================================
  Files         335      335           
  Lines       33474    33474           
=======================================
+ Hits        19030    19032    +2     
+ Misses      12854    12853    -1     
+ Partials     1590     1589    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jerm-dro jerm-dro merged commit 12683b5 into main Dec 16, 2025
30 checks passed
@jerm-dro jerm-dro deleted the jerm/2025-12-16-fix-docs branch December 16, 2025 18:42
@jerm-dro jerm-dro mentioned this pull request Dec 20, 2025
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Extra small PR: < 100 lines changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants