Document the agent skill and the script_path guarantee

Merged
KA
13h ago
+49-4

Why

The agent skill (#147) is only mentioned in the README, and the JSON docs don't say that script_path now always exists on status: ok (#148).

What

  • New docs page cli/coding-agents: install line, what the agent does step by step, and when it uses your Chrome (including Chrome's connection prompt). Linked from Installation and Scripted usage.
  • script_path in the Scripted usage table and the README JSON table: exists whenever status is ok; a run without a client reports engine_failure.

Verification

  • pnpm build passes; the new page renders and every internal link on it resolves to a built page.

Summary by cubic

Adds docs for the agent skill and documents that script_path always exists when status is "ok".

  • New clickhouse/cli/coding-agents page covers installation, step-by-step behavior, and when the skill connects to your Chrome (including the connection prompt).
  • Links to the new page from Installation and Scripted usage.
  • script_path in the README and Scripted usage tables now guarantees existence on status: "ok"; a run without a client reports engine_failure.

RetriggerView in GreptileConfidence Score: 4/5

The confirmed documentation mismatch is non-blocking; the reviewed scope contains no issue that must prevent merging.

Findings

  1. P2 Dry runs generate no client ▶
Fix with agent prompt
### Issue 1
website/content/docs/cli/scripted-usage.mdx:109
The guarantee also covers `agent --dry-run --json`, which returns `status: "ok"` with `script_path: null` when its checks pass. This page documents that command just above the table. Wrapper authors could therefore mistake a successful setup check for proof that a client exists. This is a non-blocking documentation mismatch: limit the guarantee to completed capture or engineering runs, and qualify the matching `README.md` row too.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Summary

Adds a coding-agent guide and links it from Installation and Scripted usage.

  • A new guide shows coding agents how to use the CLI.
  • The JSON docs now tie success to an existing client path.

This documentation mismatch is non-blocking. No blocking issue was found in the reviewed scope.

Reviews (1) · Last reviewed commit: "Document the agent skill and the script_..." · Reviewed by Greptile