Skip to main content

schema_json

Function schema_json 

Source
pub fn schema_json() -> String
Expand description

The machine-readable API description (D17), as pretty JSON.

The Code-Mode bet is that an agent writes code against a typed API rather than making many tool calls. Whatever language that code is eventually written in, it needs one description of the surface that cannot drift from the surface — so this is rendered from the same table that already renders --help, docs/using/cli.md, llms.txt, the three templates/ snippets and the MCP tool list, and lands in artifacts beside them so the one staleness test covers it.

Static facts only. What a particular node will accept — accounts, quotas, an ACL, the review gates — varies per deployment and cannot be generated, so the node merges a live capabilities object into this document when it serves it. Putting a runtime fact in a committed file would be a lie with a staleness test guarding it.