Skip to content

Commit 2d5cea5

Browse files
Update ToolHive reference docs for v0.1.2 (#36)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent cf8b75e commit 2d5cea5

18 files changed

+452
-1
lines changed

docs/toolhive/reference/cli/thv.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ thv [flags]
2929
* [thv inspector](thv_inspector.md) - Launches the MCP Inspector UI and connects it to the specified MCP server
3030
* [thv list](thv_list.md) - List running MCP servers
3131
* [thv logs](thv_logs.md) - Output the logs of an MCP server or manage log files
32+
* [thv mcp](thv_mcp.md) - Interact with MCP servers for debugging
3233
* [thv proxy](thv_proxy.md) - Create a transparent proxy for an MCP server with authentication support
3334
* [thv registry](thv_registry.md) - Manage MCP server registry
3435
* [thv restart](thv_restart.md) - Restart a tooling server

docs/toolhive/reference/cli/thv_config.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The config command provides subcommands to manage application configuration sett
2424
* [thv config get-ca-cert](thv_config_get-ca-cert.md) - Get the currently configured CA certificate path
2525
* [thv config get-registry-url](thv_config_get-registry-url.md) - Get the currently configured registry URL
2626
* [thv config list-registered-clients](thv_config_list-registered-clients.md) - List all registered MCP clients
27+
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
2728
* [thv config register-client](thv_config_register-client.md) - Register a client for MCP server configuration
2829
* [thv config remove-client](thv_config_remove-client.md) - Remove a client from MCP server configuration
2930
* [thv config set-ca-cert](thv_config_set-ca-cert.md) - Set the default CA certificate for container builds
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## thv config otel
2+
3+
Manage OpenTelemetry configuration
4+
5+
### Synopsis
6+
7+
Configure OpenTelemetry settings for observability and monitoring of MCP servers.
8+
9+
### Options
10+
11+
```
12+
-h, --help help for otel
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--debug Enable debug mode
19+
```
20+
21+
### SEE ALSO
22+
23+
* [thv config](thv_config.md) - Manage application configuration
24+
* [thv config otel get-endpoint](thv_config_otel_get-endpoint.md) - Get the currently configured OpenTelemetry endpoint
25+
* [thv config otel get-env-vars](thv_config_otel_get-env-vars.md) - Get the currently configured OpenTelemetry environment variables
26+
* [thv config otel get-sampling-rate](thv_config_otel_get-sampling-rate.md) - Get the currently configured OpenTelemetry sampling rate
27+
* [thv config otel set-endpoint](thv_config_otel_set-endpoint.md) - Set the OpenTelemetry endpoint URL
28+
* [thv config otel set-env-vars](thv_config_otel_set-env-vars.md) - Set the OpenTelemetry environment variables
29+
* [thv config otel set-sampling-rate](thv_config_otel_set-sampling-rate.md) - Set the OpenTelemetry sampling rate
30+
* [thv config otel unset-endpoint](thv_config_otel_unset-endpoint.md) - Remove the configured OpenTelemetry endpoint
31+
* [thv config otel unset-env-vars](thv_config_otel_unset-env-vars.md) - Remove the configured OpenTelemetry environment variables
32+
* [thv config otel unset-sampling-rate](thv_config_otel_unset-sampling-rate.md) - Remove the configured OpenTelemetry sampling rate
33+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## thv config otel get-endpoint
2+
3+
Get the currently configured OpenTelemetry endpoint
4+
5+
### Synopsis
6+
7+
Display the OpenTelemetry endpoint URL that is currently configured.
8+
9+
```
10+
thv config otel get-endpoint [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for get-endpoint
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--debug Enable debug mode
23+
```
24+
25+
### SEE ALSO
26+
27+
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
28+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## thv config otel get-env-vars
2+
3+
Get the currently configured OpenTelemetry environment variables
4+
5+
### Synopsis
6+
7+
Display the OpenTelemetry environment variables that are currently configured.
8+
9+
```
10+
thv config otel get-env-vars [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for get-env-vars
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--debug Enable debug mode
23+
```
24+
25+
### SEE ALSO
26+
27+
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
28+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## thv config otel get-sampling-rate
2+
3+
Get the currently configured OpenTelemetry sampling rate
4+
5+
### Synopsis
6+
7+
Display the OpenTelemetry sampling rate that is currently configured.
8+
9+
```
10+
thv config otel get-sampling-rate [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for get-sampling-rate
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--debug Enable debug mode
23+
```
24+
25+
### SEE ALSO
26+
27+
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
28+
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## thv config otel set-endpoint
2+
3+
Set the OpenTelemetry endpoint URL
4+
5+
### Synopsis
6+
7+
Set the OpenTelemetry OTLP endpoint URL for tracing and metrics.
8+
This endpoint will be used by default when running MCP servers unless overridden by the --otel-endpoint flag.
9+
10+
Example:
11+
thv config otel set-endpoint https://api.honeycomb.io
12+
13+
```
14+
thv config otel set-endpoint <endpoint> [flags]
15+
```
16+
17+
### Options
18+
19+
```
20+
-h, --help help for set-endpoint
21+
```
22+
23+
### Options inherited from parent commands
24+
25+
```
26+
--debug Enable debug mode
27+
```
28+
29+
### SEE ALSO
30+
31+
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
32+
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## thv config otel set-env-vars
2+
3+
Set the OpenTelemetry environment variables
4+
5+
### Synopsis
6+
7+
Set the list of environment variable names to include in OpenTelemetry spans.
8+
These environment variables will be used by default when running MCP servers unless overridden by the --otel-env-vars flag.
9+
10+
Example:
11+
thv config otel set-env-vars USER,HOME,PATH
12+
13+
```
14+
thv config otel set-env-vars <var1,var2,...> [flags]
15+
```
16+
17+
### Options
18+
19+
```
20+
-h, --help help for set-env-vars
21+
```
22+
23+
### Options inherited from parent commands
24+
25+
```
26+
--debug Enable debug mode
27+
```
28+
29+
### SEE ALSO
30+
31+
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
32+
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## thv config otel set-sampling-rate
2+
3+
Set the OpenTelemetry sampling rate
4+
5+
### Synopsis
6+
7+
Set the OpenTelemetry trace sampling rate (between 0.0 and 1.0).
8+
This sampling rate will be used by default when running MCP servers unless overridden by the --otel-sampling-rate flag.
9+
10+
Example:
11+
thv config otel set-sampling-rate 0.1
12+
13+
```
14+
thv config otel set-sampling-rate <rate> [flags]
15+
```
16+
17+
### Options
18+
19+
```
20+
-h, --help help for set-sampling-rate
21+
```
22+
23+
### Options inherited from parent commands
24+
25+
```
26+
--debug Enable debug mode
27+
```
28+
29+
### SEE ALSO
30+
31+
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
32+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## thv config otel unset-endpoint
2+
3+
Remove the configured OpenTelemetry endpoint
4+
5+
### Synopsis
6+
7+
Remove the OpenTelemetry endpoint configuration.
8+
9+
```
10+
thv config otel unset-endpoint [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for unset-endpoint
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--debug Enable debug mode
23+
```
24+
25+
### SEE ALSO
26+
27+
* [thv config otel](thv_config_otel.md) - Manage OpenTelemetry configuration
28+

0 commit comments

Comments
 (0)