diff options
| author | Anders Betts <anders.betts@gmail.com> | 2026-09-20 09:32:29 +0200 |
|---|---|---|
| committer | Anders Betts <anders.betts@gmail.com> | 2026-09-20 09:35:41 +0200 |
| commit | b6aeaa8995ae81562a4bf11937959b09027116ff (patch) | |
| tree | 90da3cbdb9afa383293544e506a180bea38f9915 /docs | |
| parent | 26d800749f5d4bb150c86215b0df4444f01ed2f6 (diff) | |
| download | bokf-b6aeaa8995ae81562a4bf11937959b09027116ff.tar.gz bokf-b6aeaa8995ae81562a4bf11937959b09027116ff.zip | |
scripts: check command and error-code drift against the docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/PROTOCOL.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/PROTOCOL.md b/docs/PROTOCOL.md index 47f6f26..16fd2c5 100644 --- a/docs/PROTOCOL.md +++ b/docs/PROTOCOL.md @@ -202,6 +202,15 @@ Cursors are opaque. ## 6. Discovery +The discovery commands themselves: + +| Command | Auth | Result | +|---|---|---| +| `health` | public | `{"status":"ok"}` | +| `meta` | public | server version, protocol version `1`, features, limits, `tcp_enabled`, `time` | +| `describe` | authenticated | full command catalogue; `{"cmd":"voucher.post"}` returns one entry | +| `agent.instructions` | authenticated | Markdown workflow rules (see 6.3) | + ### 6.1 `meta` / `health` (unauthenticated) `meta` returns server version, protocol version `1`, enabled features @@ -256,6 +265,7 @@ Arguments are shown abbreviated; `describe` is authoritative. | `session.open` | `method`, `username`, `password`, `token` | `session`, `user`, `orgs[]`, `active_org` | | `session.close` | — | `{}` | | `session.whoami` | — | `user`, `active_org`, `role`, `scopes` | +| `session.list_orgs` | — | `items[{id,name,role}]` | | `session.use_org` | `org` | `active_org`, `role` | | `org.create` | `name`, `org_nr?`, `fiscal_year_start_month?`, `moms_period?`, `framework?` | `org` | | `org.get` / `org.list` | `org?` | `org` / `items[]` | |