Skip to content

Commit 89d3f9d

Browse files
Update ToolHive reference docs for v0.6.12 (#392)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent ac12d4c commit 89d3f9d

File tree

9 files changed

+177
-6
lines changed

9 files changed

+177
-6
lines changed

docs/toolhive/reference/cli/thv_config.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,16 @@ The config command provides subcommands to manage application configuration sett
3232
### SEE ALSO
3333

3434
* [thv](thv.md) - ToolHive (thv) is a lightweight, secure, and fast manager for MCP servers
35+
* [thv config get-build-auth-file](thv_config_get-build-auth-file.md) - Get build auth file configuration
3536
* [thv config get-build-env](thv_config_get-build-env.md) - Get build environment variables
3637
* [thv config get-ca-cert](thv_config_get-ca-cert.md) - Get the currently configured CA certificate path
3738
* [thv config get-registry](thv_config_get-registry.md) - Get the currently configured registry
3839
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
40+
* [thv config set-build-auth-file](thv_config_set-build-auth-file.md) - Set an auth file for protocol builds
3941
* [thv config set-build-env](thv_config_set-build-env.md) - Set a build environment variable for protocol builds
4042
* [thv config set-ca-cert](thv_config_set-ca-cert.md) - Set the default CA certificate for container builds
4143
* [thv config set-registry](thv_config_set-registry.md) - Set the MCP server registry
44+
* [thv config unset-build-auth-file](thv_config_unset-build-auth-file.md) - Remove build auth file(s)
4245
* [thv config unset-build-env](thv_config_unset-build-env.md) - Remove build environment variable(s)
4346
* [thv config unset-ca-cert](thv_config_unset-ca-cert.md) - Remove the configured CA certificate
4447
* [thv config unset-registry](thv_config_unset-registry.md) - Remove the configured registry
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: thv config get-build-auth-file
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv config get-build-auth-file`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_config_get-build-auth-file
8+
mdx:
9+
format: md
10+
---
11+
12+
## thv config get-build-auth-file
13+
14+
Get build auth file configuration
15+
16+
### Synopsis
17+
18+
Display configured build auth files.
19+
If a name is provided, shows only that specific file.
20+
If no name is provided, shows all configured files.
21+
22+
By default, file contents are hidden to prevent credential exposure.
23+
Use --show-content to display the actual content.
24+
25+
Examples:
26+
thv config get-build-auth-file # Show all files (content hidden)
27+
thv config get-build-auth-file npmrc # Show specific file (content hidden)
28+
thv config get-build-auth-file npmrc --show-content # Show with content
29+
30+
```
31+
thv config get-build-auth-file [name] [flags]
32+
```
33+
34+
### Options
35+
36+
```
37+
-h, --help help for get-build-auth-file
38+
--show-content Show the actual file content (contains credentials)
39+
```
40+
41+
### Options inherited from parent commands
42+
43+
```
44+
--debug Enable debug mode
45+
```
46+
47+
### SEE ALSO
48+
49+
* [thv config](thv_config.md) - Manage application configuration
50+
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: thv config set-build-auth-file
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv config set-build-auth-file`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_config_set-build-auth-file
8+
mdx:
9+
format: md
10+
---
11+
12+
## thv config set-build-auth-file
13+
14+
Set an auth file for protocol builds
15+
16+
### Synopsis
17+
18+
Set authentication file content that will be injected into the container
19+
during protocol builds (npx://, uvx://, go://). This is useful for authenticating
20+
to private package registries.
21+
22+
Supported file types:
23+
npmrc - NPM configuration (~/.npmrc) for npm/npx registries
24+
netrc - Netrc file (~/.netrc) for pip, Go, and other tools
25+
yarnrc - Yarn configuration (~/.yarnrc)
26+
27+
The file content is injected into the build stage only and is NOT included
28+
in the final container image.
29+
30+
Examples:
31+
# Set npmrc for private npm registry
32+
thv config set-build-auth-file npmrc '//npm.corp.example.com/:_authToken=TOKEN'
33+
34+
# Set netrc for pip/Go authentication
35+
thv config set-build-auth-file netrc 'machine github.com login git password TOKEN'
36+
37+
# Read content from stdin (avoids exposing secrets in shell history)
38+
cat ~/.npmrc | thv config set-build-auth-file npmrc --stdin
39+
thv config set-build-auth-file npmrc --stdin < ~/.npmrc
40+
41+
Note: For multi-line content, use quotes, heredoc syntax, or --stdin.
42+
43+
```
44+
thv config set-build-auth-file <name> [content] [flags]
45+
```
46+
47+
### Options
48+
49+
```
50+
-h, --help help for set-build-auth-file
51+
--stdin Read file content from stdin instead of command line argument
52+
```
53+
54+
### Options inherited from parent commands
55+
56+
```
57+
--debug Enable debug mode
58+
```
59+
60+
### SEE ALSO
61+
62+
* [thv config](thv_config.md) - Manage application configuration
63+
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: thv config unset-build-auth-file
3+
hide_title: true
4+
description: Reference for ToolHive CLI command `thv config unset-build-auth-file`
5+
last_update:
6+
author: autogenerated
7+
slug: thv_config_unset-build-auth-file
8+
mdx:
9+
format: md
10+
---
11+
12+
## thv config unset-build-auth-file
13+
14+
Remove build auth file(s)
15+
16+
### Synopsis
17+
18+
Remove a specific build auth file or all files.
19+
20+
Examples:
21+
thv config unset-build-auth-file npmrc # Remove specific file
22+
thv config unset-build-auth-file --all # Remove all files
23+
24+
```
25+
thv config unset-build-auth-file [name] [flags]
26+
```
27+
28+
### Options
29+
30+
```
31+
--all Remove all build auth files
32+
-h, --help help for unset-build-auth-file
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
--debug Enable debug mode
39+
```
40+
41+
### SEE ALSO
42+
43+
* [thv config](thv_config.md) - Manage application configuration
44+

docs/toolhive/reference/cli/thv_proxy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ thv proxy [flags] SERVER_NAME
105105
--oidc-introspection-url string URL for token introspection endpoint
106106
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
107107
--oidc-jwks-url string URL to fetch the JWKS from
108+
--oidc-scopes strings OAuth scopes to advertise in the well-known endpoint (RFC 9728, defaults to 'openid' if not specified)
108109
--port int Port for the HTTP proxy to listen on (host port)
109110
--remote-auth Enable OAuth/OIDC authentication to remote MCP server
110111
--remote-auth-authorize-url string OAuth authorization endpoint URL (alternative to --remote-auth-issuer for non-OIDC OAuth)

docs/toolhive/reference/cli/thv_run.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
114114
--oidc-introspection-url string URL for token introspection endpoint
115115
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
116116
--oidc-jwks-url string URL to fetch the JWKS from
117+
--oidc-scopes strings OAuth scopes to advertise in the well-known endpoint (RFC 9728, defaults to 'openid' if not specified)
117118
--otel-custom-attributes string Custom resource attributes for OpenTelemetry in key=value format (e.g., server_type=prod,region=us-east-1,team=platform)
118119
--otel-enable-prometheus-metrics-path Enable Prometheus-style /metrics endpoint on the main transport port
119120
--otel-endpoint string OpenTelemetry OTLP endpoint URL (e.g., https://api.honeycomb.io)

docs/toolhive/reference/cli/thv_serve.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ thv serve [flags]
3535
--oidc-introspection-url string URL for token introspection endpoint
3636
--oidc-issuer string OIDC issuer URL (e.g., https://accounts.google.com)
3737
--oidc-jwks-url string URL to fetch the JWKS from
38+
--oidc-scopes strings OAuth scopes to advertise in the well-known endpoint (RFC 9728, defaults to 'openid' if not specified)
3839
--openapi Enable OpenAPI documentation endpoints (/api/openapi.json and /api/doc)
3940
--port int Port to bind the server to (default 8080)
4041
--socket string UNIX socket path to bind the server to (overrides host and port if provided)

static/api-specs/toolhive-api.yaml

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@ components:
8080
description: ResourceURL is the explicit resource URL for OAuth discovery
8181
(RFC 9728)
8282
type: string
83+
scopes:
84+
description: |-
85+
Scopes is the list of OAuth scopes to advertise in the well-known endpoint (RFC 9728)
86+
If empty, defaults to ["openid"]
87+
items:
88+
type: string
89+
type: array
8390
type: object
8491
authz.CedarConfig:
8592
description: |-
@@ -228,11 +235,6 @@ components:
228235
StatusContext provides additional context about the workload's status.
229236
The exact meaning is determined by the status and the underlying runtime.
230237
type: string
231-
tool_type:
232-
description: |-
233-
ToolType is the type of tool this workload represents.
234-
For now, it will always be "mcp" - representing an MCP server.
235-
type: string
236238
tools:
237239
description: ToolsFilter is the filter on tools applied to the workload.
238240
items:
@@ -1457,6 +1459,12 @@ components:
14571459
jwks_url:
14581460
description: JWKS URL for key verification
14591461
type: string
1462+
scopes:
1463+
description: OAuth scopes to advertise in well-known endpoint (RFC 9728)
1464+
items:
1465+
type: string
1466+
type: array
1467+
uniqueItems: false
14601468
type: object
14611469
v1.providerCapabilitiesResponse:
14621470
description: Capabilities of the secrets provider

static/api-specs/toolhive-legacy-registry.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
3-
"$id": "https://raw.githubusercontent.com/stacklok/toolhive/main/pkg/registry/data/schema.json",
3+
"$id": "https://raw.githubusercontent.com/stacklok/toolhive/main/pkg/registry/data/toolhive-legacy-registry.schema.json",
44
"title": "ToolHive MCP Server Registry Schema",
55
"description": "JSON Schema for the ToolHive MCP server registry. This schema validates the structure and content of registry.json entries for MCP servers. See docs/registry/management.md and docs/registry/heuristics.md for inclusion criteria and management processes.",
66
"type": "object",

0 commit comments

Comments
 (0)