schema

Returns the full method signature for a CLI command as machine-readable JSON: parameters, types, required fields, enum values, and the request and response proto type names. Agents use this to self-serve API documentation at runtime rather than relying on static docs baked into a system prompt.

Called with no arguments it lists the available method names. Pass a method name to dump one schema, or --all to dump every method schema at once.

wavecli schema
wavecli schema balance
wavecli schema --all

Flags

Example

wavecli schema balance

{
  "method": "balance",
  "description": "Display wallet balance",
  "params": null,
  "request_type": "BalanceRequest",
  "response_type": "BalanceResponse",
  "request_json_input": false,
  "mcp_tool": true,
  "side_effect": false,
  "output_schema_id": "wavecli.balance.output",
  "output_schema_version": 1
}

Each schema entry reports whether the command supports --dry-run, whether it accepts --request-json raw input (request_json_input), whether it is exposed as an MCP tool (mcp_tool), whether invoking it can change wallet or daemon state (side_effect), and the id and version of its additive output contract (output_schema_id, output_schema_version). An unknown method name exits 4 with a METHOD_NOT_FOUND envelope.

Underlying RPC

schema reads from an in-process method registry; it makes no RPC call. The dev command tree exposes the equivalent per-method schema for the generated low-level RPC surface via its --describe flag.