Compare commits

..

1 Commits

Author SHA1 Message Date
Yeachan-Heo
ea431cd67e docs(roadmap): add #681 — unsupported mcp mutation verbs return help with exit 0 2026-05-24 20:01:23 +00:00

View File

@@ -6429,38 +6429,42 @@ Original filing (2026-04-18): the session emitted `SessionStart hook (completed)
450. **`prompt` emits `kind:"missing_credentials"` JSON on STDERR (not stdout), leaving stdout at 0 bytes — automation pattern `output=$(claw prompt hello --output-format json)` captures nothing on auth-absent failure; `doctor` correctly surfaces `auth.status:"warn"` with `api_key_present:false` but exposes no `prompt_ready:false` field that automation can check before invoking `prompt`** — dogfooded 2026-05-16 by Jobdori on `a35ee9a0` in response to Clawhip pinpoint nudge at `1505208225321062521`. Exact reproduction (isolated env, no creds, fresh git repo, HEAD `a35ee9a0`): `timeout 5 env -i HOME=$ISOLATED_HOME PATH=$PATH CLAW_CONFIG_HOME=$PROBE/.claw-cfg claw prompt hello --output-format json > stdout.txt 2> stderr.txt` → stdout = **0 bytes**, stderr = 195 bytes containing `{"error":"missing Anthropic credentials…","exit_code":1,"hint":null,"kind":"missing_credentials","type":"error"}`, exit code 1. Confirms Gaebal's `1505208553793781792` pinpoint that `prompt` timeout + zero bytes was the prior state — HEAD `a35ee9a0` now correctly exits 1 with `kind:"missing_credentials"` **but the envelope is still routed to stderr** (issue #447 class, same class as prior entries #422, #435). **Contrast with `doctor`:** `claw doctor --output-format json 2>/dev/null` succeeds to stdout with `checks[auth].status:"warn"`, `api_key_present:false`, `auth_token_present:false` — but the auth check has no `prompt_ready:false` field. Automation that gates on `doctor` before invoking `prompt` must re-derive readiness from `api_key_present && auth_token_present` — there is no single canonical boolean. **Three compound problems:** (a) **stdout-empty on `--output-format json` failure**: same class as #447; `prompt`'s error envelope goes to stderr, not stdout. The canonical automation idiom `if ! result=$(claw prompt "q" --output-format json); then echo "$result" | jq .kind; fi` sees `$result=""` on failure — the jq call gets nothing. All `--output-format json` error paths must route JSON to stdout per #447 contract; (b) **`doctor` missing `prompt_ready` field**: `doctor --output-format json` already knows auth is absent (`api_key_present:false`) but surfaces no derived `prompt_ready:bool` or `prompt_blocked_reason:string` field. Automation must infer readiness from `api_key_present || auth_token_present || legacy_*_present` — a 5-field OR across legacy fields that is fragile as auth mechanisms evolve. A single `prompt_ready:false` (with `prompt_blocked_reason:"auth_missing"`) inside the `auth` check would give downstream a stable contract; (c) **`claw prompt` with no auth does no preflight and fires straight at the API**: the preflight check that `doctor` runs (auth discovery) is not reused by `prompt` to emit a fast typed error before attempting the network call. Both Gaebal's pinpoint (prompt hanging silently on older HEAD) and the current behavior (prompt hitting auth gate after a brief API attempt) stem from the same root: prompt does not short-circuit at the point where `doctor` already knows auth is absent. If `doctor` can emit `kind:"doctor"` with `auth.status:"warn"` in ~20ms without a network call, `prompt` should emit `kind:"missing_credentials"` in the same window and output it to stdout. **Required fix shape:** (a) `prompt --output-format json` must write the `kind:"missing_credentials"` JSON envelope to **stdout**, not stderr — same fix as #447 for all error envelopes; (b) add `prompt_ready:bool` and `prompt_blocked_reason:string|null` to the `auth` check in `doctor --output-format json`; derive it as `api_key_present || auth_token_present || legacy_saved_oauth_present`; (c) `prompt` must run the credential preflight check (same codepath as doctor's auth check) before attempting any API call and emit `{"kind":"missing_credentials","prompt_blocked_reason":"auth_missing"}` on **stdout** with exit 1 if the check fails; (d) `--output-format json` stdout routing fix must cover: `prompt`, `session list` (cross-ref #449), `skills uninstall` (cross-ref #431), `resume` (cross-ref #435), `acp serve` (cross-ref #443) — the full `kind:"missing_credentials"` class; (e) regression test: `claw prompt hello --output-format json` with no creds writes JSON to stdout (0 bytes stderr), exits 1, `kind:"missing_credentials"`, in under 200ms (no network attempt). **Why this matters:** `prompt` is the primary consumer entry point. Auth-absent failure routing to stderr breaks every automation wrapper that captures `$(claw prompt ... --output-format json)`. The `doctor` preflight metadata gap means auth-readiness checks require parsing 5 legacy fields instead of reading one boolean. Cross-references #447 (all JSON error envelopes on stderr), #449 (session list hits auth gate), #431 (skills uninstall hits auth gate), #357 (auth gate on local ops cluster), #422 (exit-code parity). Source: Jobdori live dogfood, `a35ee9a0`, 2026-05-16.
687. **`status --help --output-format json` is JSON-valid on current main but message-only (`{kind, command, topic, message}`), while actual `status --output-format json` exposes a large preflight schema (`workspace`, `sandbox`, `allowed_tools`, `lane_board`, `model_source`, `usage`, etc.) that help does not describe; wrappers cannot discover status output fields or local/auth semantics without invoking status and reverse-engineering the payload** — dogfooded 2026-05-24 for the 23:00 Clawhip nudge at message `1508243229626204292`, reproduced on a freshly rebuilt current `origin/main` binary (`git_sha f8e1bb726`) from `/tmp/cc-probe-main-2130`. Active claw-code sessions: none.
681. **Unsupported `claw mcp` mutation verbs (`add`, `remove`, `delete`, `enable`, `disable`) return a help payload with `exit=0` instead of a typed unsupported/not-implemented error: `claw mcp add demo -- /bin/echo hi --output-format json` emits `{kind:"mcp", action:"help", unexpected:"add demo -- /bin/echo hi", usage:{...}}` on stdout, no stderr, and no file changes. The command clearly did not add anything, but shell/CI sees success; `unexpected` is the only clue, and it is embedded in a help object rather than a `status:"unsupported"` / `kind:"error"` envelope** — dogfooded 2026-05-24 for the 20:00 Clawhip nudge at message `1508197932497899740`, reproduced on local `./rust/target/debug/claw` `git_sha 003b739d` (origin/main `f8e1bb72`) in a clean isolated env. Number intentionally jumps to #681 because Jobdori publicly filed/announced ROADMAP #680 in this channel; avoiding distributed queue collision.
Reproduction:
```bash
$ env -i HOME=/tmp/iso42/home PATH=/usr/bin:/bin TERM=dumb \
claw status --help --output-format json
$ env -i HOME=/tmp/iso29/home PATH=/usr/bin:/bin TERM=dumb \
claw mcp add demo -- /bin/echo hi --output-format json
{
"command": "status",
"kind": "help",
"message": "Status\n Usage claw status [--output-format <format>]\n Purpose show the local workspace snapshot without entering the REPL\n Output model, permissions, git state, config files, and sandbox status\n Formats text (default), json\n Related /status · claw --resume latest /status",
"topic": "status"
"action": "help",
"kind": "mcp",
"unexpected": "add demo -- /bin/echo hi",
"usage": {
"direct_cli": "claw mcp [list|show <server>|help]",
"slash_command": "/mcp [list|show <server>|help]",
"sources": [".claw/settings.json", ".claw/settings.local.json"]
}
}
# exit 0, stderr empty, no .claw/settings.json written
```
Actual status JSON on the same binary exposes many structured fields:
Same shape for:
```bash
$ claw status --output-format json | jq 'keys'
["allowed_tools", "config_load_error", "kind", "lane_board", "model", "model_raw", "model_source", "permission_mode", "sandbox", "status", "usage", "workspace"]
$ claw status --output-format json | jq '.workspace | keys'
["boot_preflight", "branch_freshness", "changed_files", "cwd", "discovered_config_files", "git_branch", "git_state", "loaded_config_files", "memory_file_count", "project_root", "session", "session_id", "session_lifecycle", "staged_files", "unstaged_files", "untracked_files"]
$ claw status --output-format json | jq '.sandbox | keys'
["active", "active_namespace", "active_network", "allowed_mounts", "enabled", "fallback_reason", "filesystem_active", "filesystem_mode", "in_container", "markers", "requested_namespace", "requested_network", "supported"]
claw mcp add demo /bin/echo hi --output-format json
claw mcp remove demo --output-format json
claw mcp delete demo --output-format json
claw mcp disable demo --output-format json
claw mcp enable demo --output-format json
```
None of this is described as structured help metadata. There is no `output_fields`, `workspace_fields`, `sandbox_fields`, `status_values`, `local_only`, `requires_credentials:false`, `requires_provider_request:false`, `mutates_workspace:false`, or `related` array.
All return `exit=0`, `kind:"mcp"`, `action:"help"`, `unexpected:"<verb ...>"` and no stderr. The supported action list in `mcp help --output-format json` is only `list|show <server>|help`, so these mutation verbs are unsupported by contract, but the failure mode is success/help.
**Why distinct from existing items:** #356 covered `status --help --output-format json` returning plain text; current main no longer reproduces that exact issue because it returns valid JSON. #687 covers the next-layer schema-depth gap: status help is message-only and does not describe the actual status output schema. #325 is broad top-level help prose-wrapper. #686 is doctor-specific check-schema help. #326/#448 cover specific status/sandbox payload correctness problems; #687 is the discoverability contract for status as a whole.
**Root cause shape:** the MCP command parser treats unknown sub-actions as a help-topic request and preserves the raw tail in `unexpected`, but does not convert that branch into a command failure. The help JSON schema has no `status`, `ok`, `error_kind`, `exit_ok`, or `unsupported_action` field, so automation must special-case `action:"help" && unexpected != null` to detect that a requested operation did not run.
**Why this matters:** `status` is the lightweight lane truth surface. Claws use it to decide model/provenance, permission mode, workspace git state, sandbox state, active session lifecycle, and lane board state before choosing work. A wrapper should not need to run status and reverse-engineer keys before it knows whether `workspace.branch_freshness`, `sandbox.filesystem_active`, or `allowed_tools.restricted` exist. Help JSON should declare the output schema and local/auth semantics.
**Why distinct from existing items:** ROADMAP #327 covers `mcp help` source-list mismatch (`.claw.json` omitted while accepted). This entry covers unsupported mutation verbs returning success. ROADMAP #347 covers `mcp show <missing>` returning `status:"ok"` with `found:false`; this entry is broader/different: unsupported *verbs* (`add/remove/enable/disable/delete`) return help with exit 0 and no command-status field. ROADMAP #102/#129 cover MCP server liveness/runtime startup; this is control-plane mutation command semantics. ROADMAP #78 covered `plugins` route falling through to prompt; this is the `mcp` route resolving locally but reporting failed mutation as successful help. No existing entry found for `mcp add/remove` write-target or unsupported mutation verbs.
**Required fix shape:** (a) Extend `status --help --output-format json` with structured fields: `usage:"claw status [--output-format <format>]"`, `formats:["text","json"]`, `related:["/status","claw --resume latest /status"]`, `local_only:true`, `requires_credentials:false`, `requires_provider_request:false`, `mutates_workspace:false`, `output_fields:["kind","status","model","model_raw","model_source","permission_mode","allowed_tools","workspace","sandbox","usage","lane_board","config_load_error"]`, `workspace_fields:[...]`, `sandbox_fields:[...]`, `status_values:["ok","degraded",...]` or equivalent documented vocabulary, and `schema_version`. (b) Keep `message` as human summary only. (c) Derive help schema from the same status renderer structs/registry so newly added status fields do not drift from help. (d) Add regression coverage proving `claw status --help --output-format json | jq '.output_fields'` contains `workspace`, `sandbox`, `allowed_tools`, and that `workspace_fields` contains `branch_freshness` / `session_lifecycle`. **Acceptance check:** `claw status --help --output-format json | jq -e '.command=="status" and .local_only==true and .requires_credentials==false and ([.output_fields[]] | index("workspace") and index("sandbox") and index("allowed_tools")) and ([.workspace_fields[]] | index("branch_freshness"))'` should pass; currently those fields are absent. Source: gaebal-gajae dogfood for the 2026-05-24 23:00 Clawhip nudge.
**Why this matters:** (1) **Automation false success.** A setup script can run `claw mcp add demo ...` and proceed because exit code is 0, even though no server was added. (2) **Mutation verbs are common user expectation.** MCP CLIs often support `add`/`remove`; users will try them. If not implemented, fail closed with a clear typed error. (3) **No write-target clarity.** Since help claims sources `.claw/settings.json` / `.claw/settings.local.json`, a user may reasonably expect `add` to write one. Returning success/help leaves them guessing. (4) **Machine contract ambiguity.** `unexpected` inside help is not an error field; claws should not have to infer failure from a non-null optional help attribute. (5) **Compounds #327.** The help object shown in the failure path also repeats the stale source-list problem, so the unsupported-action error points at incomplete config-source docs.
**Required fix shape:** (a) For unsupported MCP sub-actions, return a typed JSON error such as `{type:"error", kind:"unsupported_mcp_action", action:"add", supported_actions:["list","show","help"], hint:"MCP mutation commands are not implemented; edit .claw/settings.json manually or use ..."}` and exit non-zero. (b) Preserve a human help fallback only for explicit `mcp help` / `mcp --help`, not for attempted mutations. (c) If mutation verbs are intended roadmap features, add `not_implemented` status with non-zero exit and no file writes. (d) Add tests for `add/remove/enable/disable/delete` proving they are distinguishable from successful help and successful list/show. (e) When mutation support lands, include explicit write-target/source-layer semantics (`project`, `local`, `user`) instead of guessing. **Acceptance check:** `claw mcp add demo -- /bin/echo hi --output-format json >/tmp/out 2>/tmp/err; test $? -ne 0 && jq -e '.kind == "unsupported_mcp_action" and .action == "add"' /tmp/err` should pass; currently exit is 0 and stdout is a help object. Source: gaebal-gajae dogfood for the 2026-05-24 20:00 Clawhip nudge. Coordination note: avoided Jobdori-claimed #680/session-sort and F/CLAW_CONFIG_HOME; targeted MCP mutation semantics after pre-grep showed common MCP lifecycle gaps already covered.