Skip to content

Commit 77121ae

Browse files
Update ToolHive reference docs for v0.1.0 (#27)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a549601 commit 77121ae

File tree

8 files changed

+179
-31
lines changed

8 files changed

+179
-31
lines changed

docs/toolhive/reference/cli/thv.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ thv [flags]
2424

2525
### SEE ALSO
2626

27+
* [thv client](thv_client.md) - Manage MCP clients
2728
* [thv config](thv_config.md) - Manage application configuration
2829
* [thv inspector](thv_inspector.md) - Launches the MCP Inspector UI and connects it to the specified MCP server
2930
* [thv list](thv_list.md) - List running MCP servers
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## thv client
2+
3+
Manage MCP clients
4+
5+
### Synopsis
6+
7+
The client command provides subcommands to manage MCP client integrations.
8+
9+
### Options
10+
11+
```
12+
-h, --help help for client
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--debug Enable debug mode
19+
```
20+
21+
### SEE ALSO
22+
23+
* [thv](thv.md) - ToolHive (thv) is a lightweight, secure, and fast manager for MCP servers
24+
* [thv client setup](thv_client_setup.md) - Interactively setup and register installed clients
25+
* [thv client status](thv_client_status.md) - Show status of all supported MCP clients
26+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## thv client setup
2+
3+
Interactively setup and register installed clients
4+
5+
### Synopsis
6+
7+
Presents a list of installed but unregistered clients for interactive selection and registration.
8+
9+
```
10+
thv client setup [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for setup
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--debug Enable debug mode
23+
```
24+
25+
### SEE ALSO
26+
27+
* [thv client](thv_client.md) - Manage MCP clients
28+
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## thv client status
2+
3+
Show status of all supported MCP clients
4+
5+
### Synopsis
6+
7+
Display the installation and registration status of all supported MCP clients in a table format.
8+
9+
```
10+
thv client status [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for status
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
--debug Enable debug mode
23+
```
24+
25+
### SEE ALSO
26+
27+
* [thv client](thv_client.md) - Manage MCP clients
28+

docs/toolhive/reference/cli/thv_config.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ The config command provides subcommands to manage application configuration sett
2121
### SEE ALSO
2222

2323
* [thv](thv.md) - ToolHive (thv) is a lightweight, secure, and fast manager for MCP servers
24-
* [thv config auto-discovery](thv_config_auto-discovery.md) - Set whether to enable auto-discovery of MCP clients
2524
* [thv config get-ca-cert](thv_config_get-ca-cert.md) - Get the currently configured CA certificate path
2625
* [thv config get-registry-url](thv_config_get-registry-url.md) - Get the currently configured registry URL
2726
* [thv config list-registered-clients](thv_config_list-registered-clients.md) - List all registered MCP clients

docs/toolhive/reference/cli/thv_config_auto-discovery.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/toolhive/reference/cli/thv_run.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ thv run [flags] SERVER_OR_IMAGE_OR_PROTOCOL [-- ARGS...]
5454
--oidc-jwks-url string URL to fetch the JWKS from
5555
--otel-enable-prometheus-metrics-path Enable Prometheus-style /metrics endpoint on the main transport port
5656
--otel-endpoint string OpenTelemetry OTLP endpoint URL (e.g., https://api.honeycomb.io)
57+
--otel-env-vars stringArray Environment variable names to include in OpenTelemetry spans (comma-separated: ENV1,ENV2)
5758
--otel-headers stringArray OpenTelemetry OTLP headers in key=value format (e.g., x-honeycomb-team=your-api-key)
5859
--otel-insecure Disable TLS verification for OpenTelemetry endpoint
5960
--otel-sampling-rate float OpenTelemetry trace sampling rate (0.0-1.0) (default 0.1)

static/api-specs/toolhive-api.yaml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,22 @@ components:
262262
- TransportTypeSSE
263263
- TransportTypeStreamableHTTP
264264
- TransportTypeInspector
265+
v1.bulkClientRequest:
266+
properties:
267+
names:
268+
description: Names is the list of client names to operate on.
269+
items:
270+
type: string
271+
x-enum-varnames:
272+
- RooCode
273+
- Cline
274+
- Cursor
275+
- VSCodeInsider
276+
- VSCode
277+
- ClaudeCode
278+
type: array
279+
uniqueItems: false
280+
type: object
265281
v1.bulkOperationRequest:
266282
description: Request to perform bulk operations on workloads
267283
properties:
@@ -698,6 +714,56 @@ paths:
698714
summary: Unregister a client
699715
tags:
700716
- clients
717+
/api/v1beta/clients/register:
718+
post:
719+
description: Register multiple clients with ToolHive
720+
requestBody:
721+
content:
722+
application/json:
723+
schema:
724+
$ref: '#/components/schemas/v1.bulkClientRequest'
725+
description: Clients to register
726+
required: true
727+
responses:
728+
"200":
729+
content:
730+
application/json:
731+
schema:
732+
items:
733+
$ref: '#/components/schemas/v1.createClientResponse'
734+
type: array
735+
description: OK
736+
"400":
737+
content:
738+
application/json:
739+
schema:
740+
type: string
741+
description: Invalid request
742+
summary: Register multiple clients
743+
tags:
744+
- clients
745+
/api/v1beta/clients/unregister:
746+
post:
747+
description: Unregister multiple clients from ToolHive
748+
requestBody:
749+
content:
750+
application/json:
751+
schema:
752+
$ref: '#/components/schemas/v1.bulkClientRequest'
753+
description: Clients to unregister
754+
required: true
755+
responses:
756+
"204":
757+
description: No Content
758+
"400":
759+
content:
760+
application/json:
761+
schema:
762+
type: string
763+
description: Invalid request
764+
summary: Unregister multiple clients
765+
tags:
766+
- clients
701767
/api/v1beta/discovery/clients:
702768
get:
703769
description: List all clients compatible with ToolHive and their status
@@ -1197,6 +1263,35 @@ paths:
11971263
summary: Get workload details
11981264
tags:
11991265
- workloads
1266+
/api/v1beta/workloads/{name}/logs:
1267+
get:
1268+
description: Retrieve at most 100 lines of logs for a specific workload by name.
1269+
parameters:
1270+
- description: Workload name
1271+
in: path
1272+
name: name
1273+
required: true
1274+
schema:
1275+
type: string
1276+
responses:
1277+
"200":
1278+
content:
1279+
application/json:
1280+
schema:
1281+
type: string
1282+
text/plain:
1283+
schema:
1284+
type: string
1285+
description: Logs for the specified workload
1286+
"404":
1287+
content:
1288+
application/json:
1289+
schema:
1290+
type: string
1291+
description: Not Found
1292+
summary: Get logs for a specific workload
1293+
tags:
1294+
- logs
12001295
/api/v1beta/workloads/{name}/restart:
12011296
post:
12021297
description: Restart a running workload

0 commit comments

Comments
 (0)