Document audit, k8s export, and image verification CLI flags#936
Merged
Conversation
Fill three high-priority CLI flag gaps from issue #654 in the Run MCP servers guide: - Audit logging: explain --enable-audit (built-in defaults) versus --audit-config (custom config file), what events are captured, where events go, and the audit config fields. - Export to Kubernetes: document thv export --format k8s alongside the existing JSON export, including the MCPServer manifest output and the secrets, OIDC, and telemetry settings that must be configured separately. - Image verification: document the --image-verification flag, its warn/enabled/disabled values, the warn default, and the behavior for servers with and without provenance information. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the ToolHive CLI “Run MCP servers” guide to close documentation gaps around three high-priority thv flags/options: audit logging on thv run, Kubernetes YAML export via thv export --format k8s, and container image verification behavior via --image-verification.
Changes:
- Added a new “Enable audit logging” section documenting
--enable-auditand--audit-config, including an example audit config file and guidance on payload capture. - Added a new “Verify container image signatures” section documenting
--image-verificationmodes (warn|enabled|disabled) and expected behavior. - Expanded the “Export a server configuration” section to cover
--format(json|k8s), including a sampleMCPServermanifest and operator-related follow-ups (secrets/OIDC/telemetry).
Apply Copilot review comments: name the eventTypes/excludeEventTypes audit fields and use a writable logFile path, clarify that either audit flag enables logging, fix the image-verification note contradiction, clarify thv export operates on an existing workload, and correct the Kubernetes secrets guidance to reference spec.secrets. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
Thanks @copilot-pull-request-reviewer, all seven comments were addressed in 38a55c9:
|
The image verification section implied every registry server includes provenance information. Clarify that provenance is per-server (checkable via thv registry info) and note the effect of --image- verification enabled on servers without it, in neutral terms. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Exporting remote servers to Kubernetes is unsupported because thv export doesn't handle it, not because the operator can't run remote servers. The operator supports remote servers via the MCPRemoteProxy resource. Reword and link to the remote MCP proxy guide. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
jhrozek
approved these changes
Jun 12, 2026
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.
Description
This fills three high-priority CLI flag gaps from issue #654 in the Run MCP servers guide. It documents audit logging on
thv run(explaining the difference between--enable-auditfor built-in defaults and--audit-configfor a custom config file, what events are captured, where they go, and the audit config fields), adds thethv export --format k8soption alongside the existing JSON export (including the generatedMCPServermanifest and the secrets, OIDC, and telemetry settings that must be configured separately when deploying with the operator), and documents the--image-verificationflag with itswarn/enabled/disabledvalues,warndefault, and behavior for servers with and without provenance information. Every flag name, accepted value, default, field name, and described behavior was verified against the ToolHive source and the auto-generated CLI reference.Type of change
Related issues/PRs
Addresses #654 (high-priority gaps # 2 audit logging, # 5 export to Kubernetes, # 6 image verification)
🤖 Generated with Claude Code