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
+74-2Lines changed: 74 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,7 +117,7 @@ _Appears in:_
117
117
|`audience`_string_| Audience is the expected audience for the token |||
118
118
|`jwksUrl`_string_| JWKSURL is the URL to fetch the JWKS from |||
119
119
|`introspectionUrl`_string_| IntrospectionURL is the URL for token introspection endpoint |||
120
-
|`clientId`_string_| ClientID is deprecated and will be removed in a future release.|||
120
+
|`clientId`_string_| ClientID is the OIDC client ID|||
121
121
|`clientSecret`_string_| ClientSecret is the client secret for introspection (optional) |||
122
122
|`thvCABundlePath`_string_| ThvCABundlePath is the path to CA certificate bundle file for HTTPS requests<br />The file must be mounted into the pod (e.g., via ConfigMap or Secret volume) |||
123
123
|`jwksAuthTokenPath`_string_| JWKSAuthTokenPath is the path to file containing bearer token for JWKS/OIDC requests<br />The file must be mounted into the pod (e.g., via Secret volume) |||
@@ -137,7 +137,7 @@ _Appears in:_
137
137
138
138
| Field | Description | Default | Validation |
139
139
| --- | --- | --- | --- |
140
-
|`serviceAccount`_string_| ServiceAccount is deprecated and will be removed in a future release.|||
140
+
|`serviceAccount`_string_| ServiceAccount is the name of the service account to validate tokens for<br />If empty, uses the pod's service account|||
141
141
|`namespace`_string_| Namespace is the namespace of the service account<br />If empty, uses the MCPServer's namespace |||
142
142
|`audience`_string_| Audience is the expected audience for the token | toolhive ||
143
143
|`issuer`_string_| Issuer is the OIDC issuer URL |https://kubernetes.default.svc||
@@ -237,6 +237,7 @@ _Appears in:_
237
237
|`oidcConfig`_[OIDCConfigRef](#oidcconfigref)_| OIDCConfig defines OIDC authentication configuration for the MCP server |||
238
238
|`authzConfig`_[AuthzConfigRef](#authzconfigref)_| AuthzConfig defines authorization policy configuration for the MCP server |||
239
239
|`tools`_string array_| ToolsFilter is the filter on tools applied to the MCP server |||
240
+
|`telemetry`_[TelemetryConfig](#telemetryconfig)_| Telemetry defines observability configuration for the MCP server |||
240
241
241
242
242
243
#### MCPServerStatus
@@ -294,6 +295,43 @@ _Appears in:_
294
295
|`inline`_[InlineOIDCConfig](#inlineoidcconfig)_| Inline contains direct OIDC configuration<br />Only used when Type is "inline" |||
295
296
296
297
298
+
#### OpenTelemetryConfig
299
+
300
+
301
+
302
+
OpenTelemetryConfig defines pure OpenTelemetry configuration
303
+
304
+
305
+
306
+
_Appears in:_
307
+
-[TelemetryConfig](#telemetryconfig)
308
+
309
+
| Field | Description | Default | Validation |
310
+
| --- | --- | --- | --- |
311
+
|`enabled`_boolean_| Enabled controls whether OpenTelemetry is enabled | false ||
312
+
|`endpoint`_string_| Endpoint is the OTLP endpoint URL for tracing and metrics |||
313
+
|`serviceName`_string_| ServiceName is the service name for telemetry<br />If not specified, defaults to the MCPServer name |||
314
+
|`headers`_string array_| Headers contains authentication headers for the OTLP endpoint<br />Specified as key=value pairs |||
315
+
|`insecure`_boolean_| Insecure indicates whether to use HTTP instead of HTTPS for the OTLP endpoint | false ||
|`env`_[EnvVar](#envvar) array_| Env are environment variables to set in the proxy container (thv run process)<br />These affect the toolhive proxy itself, not the MCP server it manages |||
351
406
352
407
@@ -437,6 +492,23 @@ _Appears in:_
437
492
|`targetEnvName`_string_| TargetEnvName is the environment variable to be used when setting up the secret in the MCP server<br />If left unspecified, it defaults to the key |||
438
493
439
494
495
+
#### TelemetryConfig
496
+
497
+
498
+
499
+
TelemetryConfig defines observability configuration for the MCP server
0 commit comments