Packages

codex_sdk

0.3.0
0.17.0 0.16.1 0.16.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.1 0.10.0 0.9.0 0.8.0 0.7.2 0.7.1 0.7.0 0.6.0 0.5.0 0.4.5 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.0 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.0

Idiomatic Elixir SDK for OpenAI's Codex agent. Provides a complete, production-ready interface with streaming support, comprehensive event handling, and robust testing utilities.

HexDocs

Current section

Files

Jump to
Readme
30 Versions
6 Dependencies
Dependants
Files
Activity
codex_sdk docs 20251202 adrs adr-004-function-tools-structured-outputs.md
Raw

docs/20251202/adrs/adr-004-function-tools-structured-outputs.md 

# ADR-004: Provide Function Tool Wrapper and Structured Tool Outputs



Status: Proposed



Context

- Python: `src/agents/tool.py` `function_tool` decorator builds JSON schemas (strict optional), dynamic enablement, and tool-specific guardrails; structured tool outputs (`ToolOutputText/Image/FileContent`) serialize to Responses inputs (`items.py:429-520`).

- Elixir: tools are modules registered via `Codex.Tools.register/2`; outputs are opaque maps; no schema generation or structured output helpers.



Decision

- Add a `Codex.function_tool` macro/helper to wrap Elixir functions into tool metadata with JSON schema (strict by default) and optional enablement callbacks and error handlers.

- Define structured tool output structs (text/image/file) and conversion utilities to codex-compatible input items; ensure lists of outputs are supported.

- Retain registry approach but enrich metadata with schema/guardrail info for codex exec.



Consequences

- Benefits: parity with Python ergonomics; reduces manual schema authoring; enables image/file outputs.

- Risks: schema generation from Elixir types may be lossy; must align with codex binary expectations for tool payloads.

- Actions: implement macro + schema builder; add structured output converters; update registry storage; test against parity cases (`tests/test_function_tool.py`, `tests/test_tool_output_conversion.py`, `tests/test_function_tool_decorator.py`, `tests/test_streaming_tool_call_arguments.py`).