From ec9b6b7ee55927f7180a2dac37227f40449f22e0 Mon Sep 17 00:00:00 2001 From: Khawar Zamman Wani Date: Wed, 21 Oct 2026 01:32:14 +0530 Subject: [PATCH] Docs: launch-option wording for missing values and --help Name missing values alongside empty ones, and say `--help`/`-h` are the options that take no value (CodeRabbit review on #8035). Co-Authored-By: Claude Opus 5.5 --- book/src/automation/cli.md | 8 ++++---- book/src/automation/mcp.md | 5 +++-- docs/mcp.md | 9 +++++---- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/book/src/automation/cli.md b/book/src/automation/cli.md index 71091736bc..d33a8baad4 100644 --- a/book/src/automation/cli.md +++ b/book/src/automation/cli.md @@ -65,7 +65,7 @@ Paths supplied to the current CLI are ordinary operating-system paths. The CLI d CLI parsing reports malformed flags and JSON as errors, and a flag the subcommand doesn't take (a typo such as `--fromat`) is a usage error (exit status 2) rather than being ignored. It is not a security policy layer. Engine commands remain responsible for validating their own parameters. -`mcp` and `serve` reject positional arguments, repeated options, empty values and options for -the wrong mode before starting a server. Explicit control-token flags require `mcp --bridge` -or `serve --port`. Configure automation roots on the desktop process when using bridge mode; -the CLI rejects root flags there. See the [MCP launch guide](mcp.md) for examples. +`mcp` and `serve` reject positional arguments, repeated options, missing or empty values and +options for the wrong mode before starting a server. Explicit control-token flags require +`mcp --bridge` or `serve --port`. Configure automation roots on the desktop process when using +bridge mode; the CLI rejects root flags there. See the [MCP launch guide](mcp.md) for examples. diff --git a/book/src/automation/mcp.md b/book/src/automation/mcp.md index 9f4b5e5ace..9b2e8d7c52 100644 --- a/book/src/automation/mcp.md +++ b/book/src/automation/mcp.md @@ -25,8 +25,9 @@ client's launch directory. In bridge mode the roots are configured on the deskto flags on `photocraft-cli mcp --bridge` are rejected. Explicit `--control-token` and `--control-token-file` flags require `--bridge` and are mutually exclusive; bridge credentials can also come from `PHOTOCRAFT_CONTROL_TOKEN` or `PHOTOCRAFT_CONTROL_TOKEN_FILE`. Each launch option -takes one non-empty value and cannot be repeated. Stray positional arguments, missing values and -options for the wrong mode are usage errors (exit 2) reported on stderr before the server starts. +except `--help`/`-h` takes one non-empty value and cannot be repeated. Stray positional arguments, +missing values and options for the wrong mode are usage errors (exit 2) reported on stderr before +the server starts. Tools cover session/document operations, command discovery and execution, batching, and—when bridged—UI inspection and control. Tool schemas improve correctness but are not authorization boundaries. diff --git a/docs/mcp.md b/docs/mcp.md index df8eb012bb..f5c0b24e11 100644 --- a/docs/mcp.md +++ b/docs/mcp.md @@ -63,10 +63,11 @@ flags on `photocraft-cli mcp --bridge` are rejected. Explicit `--control-token` `--control-token-file` flags require `--bridge` and are mutually exclusive. Bridge credentials can also come from `PHOTOCRAFT_CONTROL_TOKEN` or `PHOTOCRAFT_CONTROL_TOKEN_FILE`. -MCP and `serve` launch options take one non-empty value each and cannot be repeated. Missing -values, stray positional arguments and options for the wrong mode are usage errors (exit 2), -reported on stderr before the server starts; stdout stays available for protocol messages. -For `serve`, explicit credential flags require `--port`; stdio needs no control token. +MCP and `serve` launch options (all but `--help`/`-h`) take one non-empty value each and cannot +be repeated. Missing values, stray positional arguments and options for the wrong mode are +usage errors (exit 2), reported on stderr before the server starts; stdout stays available for +protocol messages. For `serve`, explicit credential flags require `--port`; stdio needs no +control token. ## Tools and resources