Skip to content
XIDL

AI Skills

This section consolidates the most Agent-friendly context in the repository into an operational guide.

What’s Included

Section titled “What’s Included”
  • Repository terminology
  • Supported generators and transport protocols
  • Common commands
  • Location of the source of truth
  • Plugin development conventions
Section titled “Recommended Resources”
  1. docs/index.md
  2. docs/user/xidlc.md
  3. docs/user/idl.md
  4. docs/user/http.md or docs/user/jsonrpc.md
  5. docs/architecture.md
  6. docs/plugin.md

Common Commands

Section titled “Common Commands”
Terminal window
xidlc gen --out-dir out rust api.idl
xidlc gen --out-dir out rust-axum api.idl
xidlc gen --out-dir out openapi api.idl

Key Advice

Section titled “Key Advice”
  • Prioritize conclusions supported by the implementation.
  • Cross-verify with xidlc-examples/.
  • Refer to RFCs when transport semantics are unclear.
  • Examine the generator modules directly when target capabilities are unclear.