Skip to content

Commit 3d0a7a7

Browse files
author
LittleCoinCoin
committed
docs(cli): update CLI reference for parameter naming changes
Update CLIReference.md and MCPHostConfiguration.md to reflect renamed parameters: - --headers → --header - --inputs → --input Changes: - Updated syntax examples in CLIReference.md - Updated parameter table in CLIReference.md - Updated configuration type descriptions in MCPHostConfiguration.md - Updated example commands to use new parameter names
1 parent 0807712 commit 3d0a7a7

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/articles/users/CLIReference.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ Configure an MCP server on a specific host platform.
346346

347347
Syntax:
348348

349-
`hatch mcp configure <server-name> --host <host> (--command CMD | --url URL) [--args ARGS] [--env ENV] [--headers HEADERS] [--dry-run] [--auto-approve] [--no-backup]`
349+
`hatch mcp configure <server-name> --host <host> (--command CMD | --url URL) [--args ARGS] [--env ENV] [--header HEADER] [--dry-run] [--auto-approve] [--no-backup]`
350350

351351
| Argument / Flag | Type | Description | Default |
352352
|---:|---|---|---|
@@ -356,7 +356,7 @@ Syntax:
356356
| `--url` | string | URL for remote MCP servers (mutually exclusive with --command) | none |
357357
| `--args` | multiple | Arguments for MCP server command (only with --command) | none |
358358
| `--env` | string | Environment variables format: KEY=VALUE (can be used multiple times) | none |
359-
| `--headers` | string | HTTP headers format: KEY=VALUE (only with --url) | none |
359+
| `--header` | string | HTTP headers format: KEY=VALUE (only with --url) | none |
360360
| `--dry-run` | flag | Preview configuration without applying changes | false |
361361
| `--auto-approve` | flag | Skip confirmation prompts | false |
362362
| `--no-backup` | flag | Skip backup creation before configuration | false |
@@ -389,7 +389,7 @@ Configure MCP server 'my-server' on host 'claude-desktop'? [y/N]: y
389389
**Example - Remote Server Configuration**:
390390

391391
```bash
392-
$ hatch mcp configure api-server --host claude-desktop --url https://api.example.com --headers Auth=token
392+
$ hatch mcp configure api-server --host claude-desktop --url https://api.example.com --header Auth=token
393393

394394
Server 'api-server' created for host 'claude-desktop':
395395
name: UPDATED None --> 'api-server'

docs/articles/users/MCPHostConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ hatch mcp remove host claude-desktop
8787
**Important**: Each server must be configured as either local (using `--command`) or remote (using `--url`), but not both. These options are mutually exclusive:
8888

8989
- **Local servers**: Use `--command` and optionally `--args` and `--env`
90-
- **Remote servers**: Use `--url` and optionally `--headers`
90+
- **Remote servers**: Use `--url` and optionally `--header`
9191

9292
Attempting to use both `--command` and `--url` will result in an error.
9393

0 commit comments

Comments
 (0)