Merged
Conversation
Signed-off-by: Jeremy Drouillard <jeremy@stacklok.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
JAORMX
approved these changes
Dec 16, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
type: tool_callwas used in docs, but the actual valid value istype: tool(perWorkflowStep.Typeenum in the CRD)on_error:(snake_case) was used in Kubernetes CRD examples, but the actual JSON field name isonError:(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.mdtype: tool_call→type: tool#### tool_call (Phase 1)→#### tool (Phase 1)toolinstead oftool_calldocs/operator/composite-tools-quick-reference.mdon_error:→onError:docs/operator/advanced-workflow-patterns.mdon_error:→onError:docs/proposals/THV-2106-virtual-mcp-server.mdon_error:→onError:- in K8s CRD section only