Skip to Content
ReferenceOverview

Reference

Two pages here are generated straight from the code, not written by hand — make check regenerates both and fails if a committed page differs from what the code produces, so neither can drift out from under a settings or CLI change:

  • Settings — every AGENTDECK_* (and OPENAI_*/TAVILY_*) environment variable, from agentdeck/runtime/settings.py.
  • CLI — the agentdeck command tree, from agentdeck/cli.py.

The rest of the public surface is behavioral rather than tabular, so it stays hand-written prose and isn’t part of this generator:

  • Deck — the composition root: lifecycle, the turn-starting methods, and what TurnResult carries.
  • DefinitionsAgent/AgentDeclaration and Workflow/ WorkflowDeclaration, the authoring API a project builds.
  • Capabilities — removed with the sandbox; see the page for why.

Not yet published as pages:

  • Skills, the capability object a Deck composes — covered today in Skills
  • MCP, the other capability object a Deck composes — its constructor argument is on Deck, and how a connection failure degrades an agent rather than crashing the process is on Agents
  • Workflow nodes (AgentNode, LoadFileNode) — covered today in Workflows
  • HTTP endpoints
Last updated on