inspector/docs
Repository files (latest commit first)
Filename Latest commit message Latest commit date
cliffhall d4f2f2b127 docs: address Copilot review round 2 on the CLI smoke-testing guide
Four distinct issues across 2 inline and 3 suppressed comments. All were
verified against the CLI's own code and behavior before being accepted;
one was diagnosed correctly but explained wrongly, and is documented as
it actually behaves rather than as the comment stated.

1. MCP_STORAGE_DIR alone is not isolation. MCP_INSPECTOR_OAUTH_STATE_PATH
   is checked first, so an inherited value silently wins and a smoke run
   still reaches the real token file — the guide documented that
   precedence and then ignored it one paragraph later. Both variables are
   now exported, in precedence order, in §6 and in the §8 script, with a
   --list-stored-auth check that prints the path actually resolved.
   Verified: with a poisoned MCP_INSPECTOR_OAUTH_STATE_PATH in the
   environment, the two-line export wins.

2. `--format json` can carry a third top-level key. `emitResult` sets
   `schemaFindings` whenever --strict is passed to tools/list and there
   is at least one finding, so "that is the whole contract" was wrong.
   Replaced with a table of all three keys and a note to parse by key.

3. --strict findings under --format json. The actionable half is right —
   a JSON pipeline should read `schemaFindings` from stdout. The stated
   mechanism is not: `writeSchemaLintReport` runs unconditionally, so
   --format json --strict emits the full human report on stderr AND the
   structured copy on stdout. Documented both streams as measured, with
   a jq gate over the per-tool grouping. The `?` operators in that filter
   are load-bearing: the key is absent on a clean run, and without them
   jq errors instead of passing. Both arms verified.

4. The ErrorEnvelope snippet returned 0. `cmd || { … }` makes the brace
   group's status the list's, so a successful jq turned a failed run
   green — the same failure class the guide warns about twice elsewhere,
   which makes shipping it worse. Now captures, reports, and exits with
   the status; verified propagating exit 4.

The §8 script was re-run end to end against a live HTTP test server with
the added export and still passes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KsKC3HniVF9dCZtDVbYp5B
Signed-off-by: cliffhall <cliff@futurescale.com>
2026-09-06 13:43:41 -04:00
..
images docs: restore the missing docs/ targets and split the catalog-seeding wording (#1811) (#1812) 2026-07-27 20:37:14 -04:00
architecture.md Merge branch 'v2/main' into v2/chore/2163-agent-skills 2026-08-29 23:06:01 -04:00
cli-smoke-testing.md docs: address Copilot review round 2 on the CLI smoke-testing guide 2026-09-06 13:43:41 -04:00
docker.md chore: extract AGENTS.md recipes into agent skills 2026-08-29 00:36:37 -04:00
inspector-roadmap-2026-h2.md chore(scripts): rename the local pre-push gate off ci, and guard it out of CI (#2146) 2026-08-26 23:56:34 -04:00
launcher-config-consolidation-plan.md docs: restore the missing docs/ targets and split the catalog-seeding wording (#1811) (#1812) 2026-07-27 20:37:14 -04:00
mcp-app-review.md fix(web): move the app origin off 6276, bound the publish route 2026-08-24 08:45:40 -04:00
mcp-server-configuration.md fix(auth): refuse a grant whose authorization server cannot be established (#2144) 2026-08-28 06:18:58 -04:00
publishing.md chore: extract AGENTS.md recipes into agent skills 2026-08-29 00:36:37 -04:00
quality-gate.md chore: address Copilot review round 2 (#2226) 2026-09-05 16:27:46 -04:00
skill-authoring.md Review round 8: using a fixture, not connecting, is the trigger 2026-09-05 18:03:37 -04:00
test-servers.md fix: address Copilot review round 6 on #2251 2026-09-04 23:21:51 -04:00
v1-to-v2-migration.md fix(web): bound retained app documents by size; correct the cookie claim 2026-08-24 08:45:40 -04:00