Skip to content

Commit a0d03e5

Browse files
committed
Fix param style consistency
1 parent a891f6c commit a0d03e5

File tree

7 files changed

+33
-33
lines changed

7 files changed

+33
-33
lines changed

docs/toolhive/guides-cli/api-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ By default, the API server listens on `localhost` (127.0.0.1) port `8080`.
4545
You can specify a different port using the `--port` option:
4646

4747
```bash
48-
thv serve --port <port-number>
48+
thv serve --port <PORT_NUMBER>
4949
```
5050

5151
If you're running the API server on a remote host, specify the hostname or IP
5252
address to bind to using the `--host` option:
5353

5454
```bash
55-
thv serve --host <host-name>
55+
thv serve --host <HOSTNAME_OR_IP>
5656
```
5757

5858
## UNIX socket support

docs/toolhive/guides-cli/install.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ otherwise the upgrade will fail because Windows locks the executable while it
166166
runs.
167167

168168
Run `thv stop --all` to stop all running servers. After you complete the
169-
upgrade, restart them using `thv restart <server-name>`.
169+
upgrade, restart them using `thv restart <SERVER_NAME>`.
170170

171171
:::
172172

@@ -214,7 +214,7 @@ ToolHive has built-in help for all commands:
214214
thv --help
215215

216216
# Help for a specific command
217-
thv <command> --help
217+
thv <COMMAND> --help
218218
```
219219

220220
For detailed documentation on each command, see the
@@ -252,7 +252,7 @@ To uninstall ToolHive:
252252
thv list
253253
# Stop and remove each server
254254
thv stop --all
255-
thv rm <server-name>
255+
thv rm <SERVER_NAME>
256256
```
257257

258258
2. Remove all ToolHive configuration and log files:
@@ -389,7 +389,7 @@ To resolve this:
389389

390390
```powershell
391391
thv list --all
392-
thv restart <server-name>
392+
thv restart <SERVER_NAME>
393393
# repeat for each server
394394
```
395395

docs/toolhive/guides-cli/manage-mcp-servers.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ the logs with the `--follow` option, which shows the most recent log entries and
3333
updates in real time.
3434

3535
```bash
36-
thv logs <server-name> [--follow]
36+
thv logs <SERVER_NAME> [--follow]
3737
```
3838

3939
Logs are stored in the ToolHive application directory. The path depends on your
4040
platform:
4141

42-
- **macOS**: `~/Library/Application Support/toolhive/logs/<server-name>.log`
43-
- **Linux**: `~/.local/share/toolhive/logs/<server-name>.log`
42+
- **macOS**: `~/Library/Application Support/toolhive/logs/<SERVER_NAME>.log`
43+
- **Linux**: `~/.local/share/toolhive/logs/<SERVER_NAME>.log`
4444

4545
The specific log file path is displayed when you start a server with
4646
[`thv run`](../reference/cli/thv_run.md).
@@ -56,7 +56,7 @@ with the ToolHive CLI and MCP servers.
5656
To stop a running MCP server:
5757

5858
```bash
59-
thv stop <server-name>
59+
thv stop <SERVER_NAME>
6060
```
6161

6262
This stops the server and the associated proxy process, removes the MCP server's
@@ -69,15 +69,15 @@ Add the `--all` flag to stop all running servers.
6969
To restart a stopped MCP server and add it back to your configured clients:
7070

7171
```bash
72-
thv restart <server-name>
72+
thv restart <SERVER_NAME>
7373
```
7474

7575
### Remove a server
7676

7777
To remove an MCP server:
7878

7979
```bash
80-
thv rm <server-name>
80+
thv rm <SERVER_NAME>
8181
```
8282

8383
This removes the container and cleans up the MCP server's entry in your

docs/toolhive/guides-cli/registry.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ You can also search by keyword to find servers related to a specific topic or
4141
capability:
4242

4343
```bash
44-
thv search <term>
44+
thv search <TERM>
4545
```
4646

4747
For example, to locate servers related to GitHub:
@@ -55,7 +55,7 @@ thv search github
5555
To view detailed information about a specific MCP server, run:
5656

5757
```bash
58-
thv registry info <server-name>
58+
thv registry info <SERVER_NAME>
5959
```
6060

6161
For example:
@@ -71,7 +71,7 @@ By default, ToolHive displays the server's configuration in a human-readable
7171
format. To view the configuration in JSON format, use the `--format` option:
7272

7373
```bash
74-
thv registry info <server-name> --format json
74+
thv registry info <SERVER_NAME> --format json
7575
```
7676

7777
### Example output
@@ -135,7 +135,7 @@ organizations that want to maintain their own private registry of MCP servers.
135135
To configure ToolHive to use a remote registry, set the registry URL:
136136

137137
```bash
138-
thv config set-registry-url <url>
138+
thv config set-registry-url <URL>
139139
```
140140

141141
For example:

docs/toolhive/guides-cli/secrets-management.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ create or update a secret in your secret store. You can set a secret
102102
interactively by running:
103103

104104
```bash
105-
thv secret set <secret-name>
105+
thv secret set <SECRET_NAME>
106106
```
107107

108108
ToolHive prompts you to enter the secret value, and the input remains hidden for
@@ -118,7 +118,7 @@ thv secret set github
118118
Alternatively, you can set a secret using standard input:
119119

120120
```bash
121-
echo "MY_SECRET_VALUE" | thv secret set <secret-name>
121+
echo "MY_SECRET_VALUE" | thv secret set <SECRET_NAME>
122122
```
123123

124124
:::tip Example
@@ -144,15 +144,15 @@ thv secret list
144144
To decrypt and view a secret's value:
145145

146146
```bash
147-
thv secret get <secret-name>
147+
thv secret get <SECRET_NAME>
148148
```
149149

150150
### Remove a secret
151151

152152
To delete a secret when it's no longer needed:
153153

154154
```bash
155-
thv secret delete <secret-name>
155+
thv secret delete <SECRET_NAME>
156156
```
157157

158158
### Reset your secret store
@@ -206,7 +206,7 @@ To do this, use the `--secret` flag with the
206206
into the container as an environment variable.
207207

208208
```bash
209-
thv run --secret <secret-name>,target=<ENV_VAR_NAME> <server-name>
209+
thv run --secret <SECRET_NAME>,target=<ENV_VAR_NAME> <SERVER>
210210
```
211211

212212
Check the MCP server's documentation to find the expected environment variable
@@ -217,7 +217,7 @@ For MCP servers in the ToolHive registry, you can find the expected environment
217217
variable names in the server's registry entry:
218218

219219
```bash
220-
thv registry info <server-name>
220+
thv registry info <SERVER_NAME>
221221
```
222222

223223
### Example: GitHub API token
@@ -310,21 +310,21 @@ If your MCP server can't access a secret:
310310
2. Verify the secret value:
311311

312312
```bash
313-
thv secret get <secret-name>
313+
thv secret get <SECRET_NAME>
314314
```
315315

316316
3. Check that you're using the correct secret name and target environment
317317
variable. Inspect the MCP server's expected environment variables in the
318318
registry:
319319

320320
```bash
321-
thv registry info <server-name>
321+
thv registry info <SERVER_NAME>
322322
```
323323

324324
4. Inspect the server logs for any errors:
325325

326326
```bash
327-
thv logs <server-name>
327+
thv logs <SERVER_NAME>
328328
```
329329

330330
</details>

docs/toolhive/guides-k8s/deploy-operator-helm.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ helm upgrade -i toolhive-operator-crds oci://ghcr.io/stacklok/toolhive/toolhive-
2929
```
3030

3131
This command installs the latest version of the ToolHive operator CRDs Helm
32-
chart. To install a specific version, append `--version <version>` to the
32+
chart. To install a specific version, append `--version <VERSION>` to the
3333
command, for example:
3434

3535
```bash
@@ -48,7 +48,7 @@ helm upgrade -i toolhive-operator oci://ghcr.io/stacklok/toolhive/toolhive-opera
4848
```
4949

5050
This command installs the latest version of the ToolHive operator CRDs Helm
51-
chart. To install a specific version, append `--version <version>` to the
51+
chart. To install a specific version, append `--version <VERSION>` to the
5252
command, for example:
5353

5454
```bash
@@ -66,7 +66,7 @@ After about 30 seconds, you should see the `toolhive-operator` pod running.
6666
Check the logs of the operator pod:
6767

6868
```bash
69-
kubectl logs -f -n toolhive-system <toolhive-operator-pod-name>
69+
kubectl logs -f -n toolhive-system <TOOLHIVE_OPERATOR_POD_NAME>
7070
```
7171

7272
This shows you the logs of the operator pod, which can help you debug any
@@ -217,7 +217,7 @@ kubectl get clusterrolebinding | grep toolhive
217217
# Check operator pod status
218218
kubectl get pods -n toolhive-system
219219
# Check operator pod logs
220-
kubectl logs -n toolhive-system <toolhive-operator-pod-name>
220+
kubectl logs -n toolhive-system <TOOLHIVE_OPERATOR_POD_NAME>
221221
```
222222

223223
## Upgrade the operator
@@ -291,8 +291,8 @@ the pod logs for error messages:
291291
kubectl get pods -n toolhive-system
292292
# Note the name of the toolhive-operator pod
293293
294-
kubectl describe pod -n toolhive-system <toolhive-operator-pod-name>
295-
kubectl logs -n toolhive-system <toolhive-operator-pod-name>
294+
kubectl describe pod -n toolhive-system <TOOLHIVE_OPERATOR_POD_NAME>
295+
kubectl logs -n toolhive-system <TOOLHIVE_OPERATOR_POD_NAME>
296296
```
297297

298298
Common causes include:
@@ -320,7 +320,7 @@ permission issues:
320320
kubectl get crd | grep toolhive
321321
322322
# Remove existing CRDs if needed (this will delete all related resources)
323-
kubectl delete crd <crd-name>
323+
kubectl delete crd <CRD_NAME>
324324
```
325325

326326
To reinstall the CRDs:

docs/toolhive/tutorials/quickstart-cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ server. Here are some next steps to explore:
288288

289289
- Try running other MCP servers from the registry with
290290
[`thv registry list`](../reference/cli/thv_registry_list.md) and
291-
[`thv run <server-name>`](../reference/cli/thv_run.md)
291+
[`thv run`](../reference/cli/thv_run.md)
292292
- Learn about [secrets management](../guides-cli/secrets-management.mdx) for MCP
293293
servers that require authentication
294294
- Explore [custom permissions](../guides-cli/custom-permissions.mdx) for MCP

0 commit comments

Comments
 (0)