From 5e9227b093013b557d6faf3c481f449c910ca614 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 10 Nov 2025 16:40:00 +0000 Subject: [PATCH] Update ToolHive reference docs for toolhive-operator-crds-0.0.54 --- static/api-specs/toolhive-crd-api.md | 50 +++------------------------- 1 file changed, 5 insertions(+), 45 deletions(-) diff --git a/static/api-specs/toolhive-crd-api.md b/static/api-specs/toolhive-crd-api.md index 395f3dd..23d4e3e 100644 --- a/static/api-specs/toolhive-crd-api.md +++ b/static/api-specs/toolhive-crd-api.md @@ -160,25 +160,6 @@ _Appears in:_ | `externalAuthConfigRef` _[ExternalAuthConfigRef](#externalauthconfigref)_ | ExternalAuthConfigRef references an MCPExternalAuthConfig resource
Only used when Type is "external_auth_config_ref" | | | -#### CapabilitiesSummary - - - -CapabilitiesSummary summarizes aggregated capabilities - - - -_Appears in:_ -- [VirtualMCPServerStatus](#virtualmcpserverstatus) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `toolCount` _integer_ | ToolCount is the total number of tools exposed | | | -| `resourceCount` _integer_ | ResourceCount is the total number of resources exposed | | | -| `promptCount` _integer_ | PromptCount is the total number of prompts exposed | | | -| `compositeToolCount` _integer_ | CompositeToolCount is the number of composite tools defined | | | - - #### CircuitBreakerConfig @@ -302,27 +283,6 @@ _Appears in:_ | `priorityOrder` _string array_ | PriorityOrder defines the workload priority order for the "priority" strategy | | | -#### DiscoveredBackend - - - -DiscoveredBackend represents a discovered backend MCPServer - - - -_Appears in:_ -- [VirtualMCPServerStatus](#virtualmcpserverstatus) - -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `name` _string_ | Name is the name of the backend MCPServer | | Required: \{\}
| -| `authConfigRef` _string_ | AuthConfigRef is the name of the discovered MCPExternalAuthConfig
Empty if backend has no external auth config | | | -| `authType` _string_ | AuthType is the type of authentication configured | | | -| `status` _string_ | Status is the current status of the backend | | Enum: [ready degraded unavailable]
| -| `lastHealthCheck` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta)_ | LastHealthCheck is the timestamp of the last health check | | | -| `url` _string_ | URL is the URL of the backend MCPServer | | | - - #### EnvVar @@ -447,6 +407,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | +| `type` _string_ | Type defines the authentication type: anonymous, local, or oidc | | Enum: [anonymous local oidc]
| | `oidcConfig` _[OIDCConfigRef](#oidcconfigref)_ | OIDCConfig defines OIDC authentication configuration
Reuses MCPServer OIDC patterns | | | | `authzConfig` _[AuthzConfigRef](#authzconfigref)_ | AuthzConfig defines authorization policy configuration
Reuses MCPServer authz patterns | | | @@ -1010,7 +971,7 @@ _Appears in:_ | --- | --- | --- | --- | | `image` _string_ | Image is the container image for the MCP server | | Required: \{\}
| | `transport` _string_ | Transport is the transport method for the MCP server (stdio, streamable-http or sse) | stdio | Enum: [stdio streamable-http sse]
| -| `proxyMode` _string_ | ProxyMode is the proxy mode for stdio transport (sse or streamable-http)
This setting is only used when Transport is "stdio" | sse | Enum: [sse streamable-http]
| +| `proxyMode` _string_ | ProxyMode is the proxy mode for stdio transport (sse or streamable-http)
This setting is only used when Transport is "stdio" | streamable-http | Enum: [sse streamable-http]
| | `port` _integer_ | Port is the port to expose the MCP server on
Deprecated: Use ProxyPort instead | 8080 | Maximum: 65535
Minimum: 1
| | `targetPort` _integer_ | TargetPort is the port that MCP server listens to
Deprecated: Use McpPort instead | | Maximum: 65535
Minimum: 1
| | `proxyPort` _integer_ | ProxyPort is the port to expose the proxy runner on | 8080 | Maximum: 65535
Minimum: 1
| @@ -1742,8 +1703,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `tokenUrl` _string_ | TokenURL is the OAuth 2.0 token endpoint URL for token exchange | | Required: \{\}
| -| `clientId` _string_ | ClientID is the OAuth 2.0 client identifier | | Required: \{\}
| -| `clientSecretRef` _[SecretKeyRef](#secretkeyref)_ | ClientSecretRef is a reference to a secret containing the OAuth 2.0 client secret | | Required: \{\}
| +| `clientId` _string_ | ClientID is the OAuth 2.0 client identifier
Optional for some token exchange flows (e.g., Google Cloud Workforce Identity) | | | +| `clientSecretRef` _[SecretKeyRef](#secretkeyref)_ | ClientSecretRef is a reference to a secret containing the OAuth 2.0 client secret
Optional for some token exchange flows (e.g., Google Cloud Workforce Identity) | | | | `audience` _string_ | Audience is the target audience for the exchanged token | | Required: \{\}
| | `scopes` _string array_ | Scopes is a list of OAuth 2.0 scopes to request for the exchanged token | | | | `externalTokenHeaderName` _string_ | ExternalTokenHeaderName is the name of the custom header to use for the exchanged token.
If set, the exchanged token will be added to this custom header (e.g., "X-Upstream-Token").
If empty or not set, the exchanged token will replace the Authorization header (default behavior). | | | @@ -1976,6 +1937,7 @@ _Appears in:_ | `compositeToolRefs` _[CompositeToolDefinitionRef](#compositetooldefinitionref) array_ | CompositeToolRefs references VirtualMCPCompositeToolDefinition resources
for complex, reusable workflows | | | | `tokenCache` _[TokenCacheConfig](#tokencacheconfig)_ | TokenCache configures token caching behavior | | | | `operational` _[OperationalConfig](#operationalconfig)_ | Operational defines operational settings like timeouts and health checks | | | +| `serviceType` _string_ | ServiceType specifies the Kubernetes service type for the Virtual MCP server | ClusterIP | Enum: [ClusterIP NodePort LoadBalancer]
| | `podTemplateSpec` _[RawExtension](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#rawextension-runtime-pkg)_ | PodTemplateSpec defines the pod template to use for the Virtual MCP server
This allows for customizing the pod configuration beyond what is provided by the other fields.
Note that to modify the specific container the Virtual MCP server runs in, you must specify
the 'vmcp' container name in the PodTemplateSpec.
This field accepts a PodTemplateSpec object as JSON/YAML. | | Type: object
| @@ -1993,8 +1955,6 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#condition-v1-meta) array_ | Conditions represent the latest available observations of the VirtualMCPServer's state | | | -| `discoveredBackends` _[DiscoveredBackend](#discoveredbackend) array_ | DiscoveredBackends lists discovered backend configurations when source=discovered | | | -| `capabilities` _[CapabilitiesSummary](#capabilitiessummary)_ | Capabilities summarizes aggregated capabilities from all backends | | | | `observedGeneration` _integer_ | ObservedGeneration is the most recent generation observed for this VirtualMCPServer | | | | `phase` _[VirtualMCPServerPhase](#virtualmcpserverphase)_ | Phase is the current phase of the VirtualMCPServer | Pending | Enum: [Pending Ready Degraded Failed]
| | `message` _string_ | Message provides additional information about the current phase | | |