Skip to content

Commit dea8537

Browse files
Update ToolHive reference docs for toolhive-operator-crds-0.0.54 (#287)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 7e34960 commit dea8537

File tree

1 file changed

+5
-45
lines changed

1 file changed

+5
-45
lines changed

static/api-specs/toolhive-crd-api.md

Lines changed: 5 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -160,25 +160,6 @@ _Appears in:_
160160
| `externalAuthConfigRef` _[ExternalAuthConfigRef](#externalauthconfigref)_ | ExternalAuthConfigRef references an MCPExternalAuthConfig resource<br />Only used when Type is "external_auth_config_ref" | | |
161161

162162

163-
#### CapabilitiesSummary
164-
165-
166-
167-
CapabilitiesSummary summarizes aggregated capabilities
168-
169-
170-
171-
_Appears in:_
172-
- [VirtualMCPServerStatus](#virtualmcpserverstatus)
173-
174-
| Field | Description | Default | Validation |
175-
| --- | --- | --- | --- |
176-
| `toolCount` _integer_ | ToolCount is the total number of tools exposed | | |
177-
| `resourceCount` _integer_ | ResourceCount is the total number of resources exposed | | |
178-
| `promptCount` _integer_ | PromptCount is the total number of prompts exposed | | |
179-
| `compositeToolCount` _integer_ | CompositeToolCount is the number of composite tools defined | | |
180-
181-
182163
#### CircuitBreakerConfig
183164

184165

@@ -302,27 +283,6 @@ _Appears in:_
302283
| `priorityOrder` _string array_ | PriorityOrder defines the workload priority order for the "priority" strategy | | |
303284

304285

305-
#### DiscoveredBackend
306-
307-
308-
309-
DiscoveredBackend represents a discovered backend MCPServer
310-
311-
312-
313-
_Appears in:_
314-
- [VirtualMCPServerStatus](#virtualmcpserverstatus)
315-
316-
| Field | Description | Default | Validation |
317-
| --- | --- | --- | --- |
318-
| `name` _string_ | Name is the name of the backend MCPServer | | Required: \{\} <br /> |
319-
| `authConfigRef` _string_ | AuthConfigRef is the name of the discovered MCPExternalAuthConfig<br />Empty if backend has no external auth config | | |
320-
| `authType` _string_ | AuthType is the type of authentication configured | | |
321-
| `status` _string_ | Status is the current status of the backend | | Enum: [ready degraded unavailable] <br /> |
322-
| `lastHealthCheck` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta)_ | LastHealthCheck is the timestamp of the last health check | | |
323-
| `url` _string_ | URL is the URL of the backend MCPServer | | |
324-
325-
326286

327287

328288
#### EnvVar
@@ -447,6 +407,7 @@ _Appears in:_
447407

448408
| Field | Description | Default | Validation |
449409
| --- | --- | --- | --- |
410+
| `type` _string_ | Type defines the authentication type: anonymous, local, or oidc | | Enum: [anonymous local oidc] <br /> |
450411
| `oidcConfig` _[OIDCConfigRef](#oidcconfigref)_ | OIDCConfig defines OIDC authentication configuration<br />Reuses MCPServer OIDC patterns | | |
451412
| `authzConfig` _[AuthzConfigRef](#authzconfigref)_ | AuthzConfig defines authorization policy configuration<br />Reuses MCPServer authz patterns | | |
452413

@@ -1010,7 +971,7 @@ _Appears in:_
1010971
| --- | --- | --- | --- |
1011972
| `image` _string_ | Image is the container image for the MCP server | | Required: \{\} <br /> |
1012973
| `transport` _string_ | Transport is the transport method for the MCP server (stdio, streamable-http or sse) | stdio | Enum: [stdio streamable-http sse] <br /> |
1013-
| `proxyMode` _string_ | ProxyMode is the proxy mode for stdio transport (sse or streamable-http)<br />This setting is only used when Transport is "stdio" | sse | Enum: [sse streamable-http] <br /> |
974+
| `proxyMode` _string_ | ProxyMode is the proxy mode for stdio transport (sse or streamable-http)<br />This setting is only used when Transport is "stdio" | streamable-http | Enum: [sse streamable-http] <br /> |
1014975
| `port` _integer_ | Port is the port to expose the MCP server on<br />Deprecated: Use ProxyPort instead | 8080 | Maximum: 65535 <br />Minimum: 1 <br /> |
1015976
| `targetPort` _integer_ | TargetPort is the port that MCP server listens to<br />Deprecated: Use McpPort instead | | Maximum: 65535 <br />Minimum: 1 <br /> |
1016977
| `proxyPort` _integer_ | ProxyPort is the port to expose the proxy runner on | 8080 | Maximum: 65535 <br />Minimum: 1 <br /> |
@@ -1742,8 +1703,8 @@ _Appears in:_
17421703
| Field | Description | Default | Validation |
17431704
| --- | --- | --- | --- |
17441705
| `tokenUrl` _string_ | TokenURL is the OAuth 2.0 token endpoint URL for token exchange | | Required: \{\} <br /> |
1745-
| `clientId` _string_ | ClientID is the OAuth 2.0 client identifier | | Required: \{\} <br /> |
1746-
| `clientSecretRef` _[SecretKeyRef](#secretkeyref)_ | ClientSecretRef is a reference to a secret containing the OAuth 2.0 client secret | | Required: \{\} <br /> |
1706+
| `clientId` _string_ | ClientID is the OAuth 2.0 client identifier<br />Optional for some token exchange flows (e.g., Google Cloud Workforce Identity) | | |
1707+
| `clientSecretRef` _[SecretKeyRef](#secretkeyref)_ | ClientSecretRef is a reference to a secret containing the OAuth 2.0 client secret<br />Optional for some token exchange flows (e.g., Google Cloud Workforce Identity) | | |
17471708
| `audience` _string_ | Audience is the target audience for the exchanged token | | Required: \{\} <br /> |
17481709
| `scopes` _string array_ | Scopes is a list of OAuth 2.0 scopes to request for the exchanged token | | |
17491710
| `externalTokenHeaderName` _string_ | ExternalTokenHeaderName is the name of the custom header to use for the exchanged token.<br />If set, the exchanged token will be added to this custom header (e.g., "X-Upstream-Token").<br />If empty or not set, the exchanged token will replace the Authorization header (default behavior). | | |
@@ -1976,6 +1937,7 @@ _Appears in:_
19761937
| `compositeToolRefs` _[CompositeToolDefinitionRef](#compositetooldefinitionref) array_ | CompositeToolRefs references VirtualMCPCompositeToolDefinition resources<br />for complex, reusable workflows | | |
19771938
| `tokenCache` _[TokenCacheConfig](#tokencacheconfig)_ | TokenCache configures token caching behavior | | |
19781939
| `operational` _[OperationalConfig](#operationalconfig)_ | Operational defines operational settings like timeouts and health checks | | |
1940+
| `serviceType` _string_ | ServiceType specifies the Kubernetes service type for the Virtual MCP server | ClusterIP | Enum: [ClusterIP NodePort LoadBalancer] <br /> |
19791941
| `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<br />This allows for customizing the pod configuration beyond what is provided by the other fields.<br />Note that to modify the specific container the Virtual MCP server runs in, you must specify<br />the 'vmcp' container name in the PodTemplateSpec.<br />This field accepts a PodTemplateSpec object as JSON/YAML. | | Type: object <br /> |
19801942

19811943

@@ -1993,8 +1955,6 @@ _Appears in:_
19931955
| Field | Description | Default | Validation |
19941956
| --- | --- | --- | --- |
19951957
| `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 | | |
1996-
| `discoveredBackends` _[DiscoveredBackend](#discoveredbackend) array_ | DiscoveredBackends lists discovered backend configurations when source=discovered | | |
1997-
| `capabilities` _[CapabilitiesSummary](#capabilitiessummary)_ | Capabilities summarizes aggregated capabilities from all backends | | |
19981958
| `observedGeneration` _integer_ | ObservedGeneration is the most recent generation observed for this VirtualMCPServer | | |
19991959
| `phase` _[VirtualMCPServerPhase](#virtualmcpserverphase)_ | Phase is the current phase of the VirtualMCPServer | Pending | Enum: [Pending Ready Degraded Failed] <br /> |
20001960
| `message` _string_ | Message provides additional information about the current phase | | |

0 commit comments

Comments
 (0)