agent() API Agent, runtime, context, skill, memory, MCP, and RLM APIs. cpp api api/agent packages/cpp/axir-api.json api agent() API

agent() API

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

Most Used

axllm::agent

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

FieldValue
Kindfunction
Ax conceptagent
API sectionAgents And RLM
Formaxllm::agent(signature, options)
ReturnsAxAgent

Important Options

  • name
  • description
  • runtime
  • maxSteps
  • context fields
  • discovery
  • recall
  • functions

Examples

C++
auto helper = axllm::agent("query:string -> answer:string");

Full reference

axllm::AxAgent

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

FieldValue
Kindtype
Ax conceptAxAgent
API sectionAgents And RLM
Formaxllm::AxAgent(signature, options)
Returnsagent program

Important Options

  • executor model
  • runtime
  • policy
  • context
  • optimizer metadata

Full reference

axllm::AxMCPClient

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

FieldValue
Kindtype
Ax conceptAxMCPClient
API sectionMCP
Formaxllm::AxMCPClient(transport, options)
ReturnsMCP client

Important Options

  • transport
  • client info
  • roots
  • tool overrides

Examples

C++
axllm::AxMCPClient client(transport);

Full reference

axllm::AxMCPStreamableHTTPTransport

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

FieldValue
Kindtype
Ax conceptAxMCPStreamableHTTPTransport
API sectionMCP
Formaxllm::AxMCPStreamableHTTPTransport(endpoint, options)
ReturnsMCP transport

Important Options

  • endpoint
  • headers
  • OAuth
  • SSRF protection

Full reference

axllm::AxMCPStdioTransport

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

FieldValue
Kindtype
Ax conceptAxMCPStdioTransport
API sectionMCP
Formaxllm::AxMCPStdioTransport(command, options)
ReturnsMCP transport

Important Options

  • command
  • args
  • env

Full reference

Advanced / internals / full reference

axllm::ProcessCodeRuntime

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

FieldValue
Kindtype
Ax conceptProcessCodeRuntime
API sectionRuntime Profiles
Formaxllm::RuntimeProtocolClient(transport)
ReturnsAxCodeRuntime

Important Options

  • command
  • env
  • cwd
  • timeout

Examples

C++
auto runtime = axllm::RuntimeProtocolClient(transport);

Full reference

axllm::RuntimeCapabilities

Runtime capability envelope visible to the agent runtime policy.

FieldValue
Kindtype
Ax conceptRuntimeCapabilities
API sectionRuntime Profiles
Formaxllm::RuntimeCapabilities
Returnscapability record

Important Options

  • language
  • snapshot
  • patch
  • abort
  • usage instructions

Full reference

axllm::RuntimeEnvelope

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

FieldValue
Kindtype
Ax conceptRuntimeEnvelope
API sectionRuntime Profiles
Formaxllm::RuntimeEnvelope
Returnsruntime envelope

Important Options

  • type
  • args
  • result
  • error

Full reference

javascript-quickjs

Optional runtime profile for javascript actor code.

FieldValue
Kindruntime-profile
Ax conceptruntime-profile:javascript-quickjs
API sectionRuntime Profiles
Formtools/axir verify --targets cpp --runtime-profiles javascript-quickjs
ReturnsAxCodeRuntime-compatible actor execution profile

Important Options

  • actor language: javascript
  • support mode: embedded
  • dependency mode: optional-build
  • feature gate: AX_BUILD_QUICKJS_PROFILE
  • environment gate: AXIR_QUICKJS_CFLAGS
  • environment gate: AXIR_QUICKJS_LDFLAGS

Full reference

python-pyodide

Optional runtime profile for python actor code.

FieldValue
Kindruntime-profile
Ax conceptruntime-profile:python-pyodide
API sectionRuntime Profiles
Formtools/axir verify --targets cpp --runtime-profiles python-pyodide
ReturnsAxCodeRuntime-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 C++ reference. This page highlights the agent symbols most relevant to everyday use.

Docs