agent() API

Agent, RLM runtime, context, memory, skill, MCP, and delegation APIs.

Most Used

`Ax.agent`

Create an AxAgent from a signature and agent/runtime options.

Field	Value
Kind	`function`
Ax concept	`agent`
API section	Agents And RLM
Form	`Ax.agent(signature, options)`
Returns	AxAgent

Important Options

name
description
runtime
maxSteps
context fields
discovery
recall
functions

Examples

Java

AxAgent helper = Ax.agent("query:string -> answer:string", Map.of());

Full reference

`AxAgent`

RLM agent with Core-owned envelopes, state, traces, discovery, recall, delegation, and final typed responses.

Field	Value
Kind	`type`
Ax concept	`AxAgent`
API section	Agents And RLM
Form	`new AxAgent(signature, options)`
Returns	agent program

Important Options

executor model
runtime
policy
context
optimizer metadata

Full reference

`AxMCPClient`

MCP client that lists tools/prompts/resources and converts MCP tools to Ax functions.

Field	Value
Kind	`type`
Ax concept	`AxMCPClient`
API section	MCP
Form	`new AxMCPClient(transport, options)`
Returns	MCP client

Important Options

transport
client info
roots
tool overrides

Examples

Java

AxMCPClient client = new AxMCPClient(transport);

Full reference

`AxMCPStreamableHTTPTransport`

Streamable HTTP transport with session headers, OAuth options, and SSRF protection.

Field	Value
Kind	`type`
Ax concept	`AxMCPStreamableHTTPTransport`
API section	MCP
Form	`new AxMCPStreamableHTTPTransport(endpoint, options)`
Returns	MCP transport

Important Options

endpoint
headers
OAuth
SSRF protection

Full reference

`AxMCPStdioTransport`

Stdio transport with JSON-RPC framing for local MCP servers.

Field	Value
Kind	`type`
Ax concept	`AxMCPStdioTransport`
API section	MCP
Form	`new AxMCPStdioTransport(command, options)`
Returns	MCP transport

Important Options

command
args
env

Full reference

Advanced / internals / full reference

`ProcessCodeRuntime`

Process/JSONL runtime adapter for actor-code sessions and runtime protocol tests.

Field	Value
Kind	`type`
Ax concept	`ProcessCodeRuntime`
API section	Runtime Profiles
Form	`new AxProcessCodeRuntime(command, env)`
Returns	AxCodeRuntime

Important Options

command
env
cwd
timeout

Examples

Java

AxCodeRuntime runtime = new AxProcessCodeRuntime(List.of("node", "runtime-server.mjs"), Map.of());

Full reference

`RuntimeCapabilities`

Runtime capability envelope visible to the agent runtime policy.

Field	Value
Kind	`type`
Ax concept	`RuntimeCapabilities`
API section	Runtime Profiles
Form	`new AxRuntimeCapabilities()`
Returns	capability record

Important Options

language
snapshot
patch
abort
usage instructions

Full reference

`RuntimeEnvelope`

Actor primitive envelope for final, clarification, discovery, recall, used, guidance, and runtime results.

Field	Value
Kind	`type`
Ax concept	`RuntimeEnvelope`
API section	Runtime Profiles
Form	`AxRuntimeEnvelope`
Returns	runtime envelope

Important Options

type
args
result
error

Full reference

`javascript-quickjs`

Optional runtime profile for javascript actor code.

Field	Value
Kind	`runtime-profile`
Ax concept	`runtime-profile:javascript-quickjs`
API section	Runtime Profiles
Form	`tools/axir verify --targets java --runtime-profiles javascript-quickjs`
Returns	AxCodeRuntime-compatible actor execution profile

Important Options

actor language: javascript
support mode: embedded
dependency mode: optional-classpath
environment gate: AXIR_QUICKJS4J_CP
environment gate: AXIR_QUICKJS4J_CP_FILE
environment gate: AXIR_QUICKJS4J_RESOLVE

Full reference

`python-pyodide`

Optional runtime profile for python actor code.

Field	Value
Kind	`runtime-profile`
Ax concept	`runtime-profile:python-pyodide`
API section	Runtime Profiles
Form	`tools/axir verify --targets java --runtime-profiles python-pyodide`
Returns	AxCodeRuntime-compatible actor execution profile

Important Options

actor language: python
support mode: process-adapter
dependency mode: optional-env
environment gate: AXIR_PYODIDE_RUNTIME_SERVER
environment gate: AXIR_PYODIDE_RESOLVE

Full reference

Full Reference

Open the full Java reference. This page highlights the agent symbols most relevant to everyday use.