You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: static/api-specs/toolhive-crd-api.md
+5-45Lines changed: 5 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -160,25 +160,6 @@ _Appears in:_
160
160
|`externalAuthConfigRef`_[ExternalAuthConfigRef](#externalauthconfigref)_| ExternalAuthConfigRef references an MCPExternalAuthConfig resource<br />Only used when Type is "external_auth_config_ref" |||
|`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
-
326
286
327
287
328
288
#### EnvVar
@@ -447,6 +407,7 @@ _Appears in:_
447
407
448
408
| Field | Description | Default | Validation |
449
409
| --- | --- | --- | --- |
410
+
|`type`_string_| Type defines the authentication type: anonymous, local, or oidc || Enum: [anonymous local oidc] <br /> |
|`image`_string_| Image is the container image for the MCP server || Required: \{\} <br /> |
1012
973
|`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 /> |
1014
975
|`port`_integer_| Port is the port to expose the MCP server on<br />Deprecated: Use ProxyPort instead | 8080 | Maximum: 65535 <br />Minimum: 1 <br /> |
1015
976
|`targetPort`_integer_| TargetPort is the port that MCP server listens to<br />Deprecated: Use McpPort instead || Maximum: 65535 <br />Minimum: 1 <br /> |
1016
977
|`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:_
1742
1703
| Field | Description | Default | Validation |
1743
1704
| --- | --- | --- | --- |
1744
1705
|`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) |||
1747
1708
|`audience`_string_| Audience is the target audience for the exchanged token || Required: \{\} <br /> |
1748
1709
|`scopes`_string array_| Scopes is a list of OAuth 2.0 scopes to request for the exchanged token |||
1749
1710
|`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). |||
|`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 /> |
1979
1941
|`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 /> |
1980
1942
1981
1943
@@ -1993,8 +1955,6 @@ _Appears in:_
1993
1955
| Field | Description | Default | Validation |
1994
1956
| --- | --- | --- | --- |
1995
1957
|`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 |||
1998
1958
|`observedGeneration`_integer_| ObservedGeneration is the most recent generation observed for this VirtualMCPServer |||
1999
1959
|`phase`_[VirtualMCPServerPhase](#virtualmcpserverphase)_| Phase is the current phase of the VirtualMCPServer | Pending | Enum: [Pending Ready Degraded Failed] <br /> |
2000
1960
|`message`_string_| Message provides additional information about the current phase |||
0 commit comments