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

agent() API

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

Most Used

axllm.NewAgent

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

FieldValue
Kindfunction
Ax conceptagent
API sectionAgents And RLM
Formaxllm.NewAgent(signature, options)
Returns*AxAgent

Important Options

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

Examples

Go
helper := axllm.NewAgent("query:string -> answer:string", nil)

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.NewAgent(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.NewAxMCPClient(transport, options)
ReturnsMCP client

Important Options

  • transport
  • client info
  • roots
  • tool overrides

Examples

Go
client := axllm.NewAxMCPClient(transport, nil)

Full reference

axllm.AxMCPStreamableHTTPTransport

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

FieldValue
Kindtype
Ax conceptAxMCPStreamableHTTPTransport
API sectionMCP
Formaxllm.NewAxMCPStreamableHTTPTransport(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.NewAxMCPStdioTransport(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.NewProcessCodeRuntime(command, env)
ReturnsAxCodeRuntime

Important Options

  • command
  • env
  • cwd
  • timeout

Examples

Go
runtime := axllm.NewProcessCodeRuntime([]string{"node", "runtime-server.mjs"}, nil)

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
Formruntime envelope map
Returnsruntime envelope

Important Options

  • type
  • args
  • result
  • error

Full reference

javascript-goja

Optional runtime profile for javascript actor code.

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

Important Options

  • actor language: javascript
  • support mode: embedded
  • dependency mode: optional-import

Full reference

Full Reference

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

Docs