ax AGENTS.md

A repository guide for the ax TypeScript library and its related packages. It tells coding agents where source code and official documentation live, and which current coding patterns to use.

In plain words
What is it for?
Use it when changing ax code, documentation, examples, or the website, especially when deciding where to edit files and which API style to follow.
Why use it?
It prevents agents from treating generated website files as source files or using outdated APIs. It also gives the project’s layout and conventions in one short reference.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/ax-llm/ax/agents-md
Clone the repo
git clone --depth 1 https://github.com/ax-llm/ax

Made for: Codex, OpenCode.

Per session 1,548 This file is loaded in full into every session.
When invoked 1,548 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01548 $0.01548
Opus 5 $0.00774 $0.00774
Sonnet 5 $0.00310 $0.00310
Haiku 4.5 $0.00155 $0.00155

Measured 3d ago against content hash e216ef241ab6, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

ax AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 150 lines

How it starts

The opening of the file, as written. The whole thing — 150 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Ax Repository Guide

What This File Is For

This file should stay short.

Use it for repo-specific rules, workspace conventions, and pointers to the deeper subsystem docs in src/ax/skills/.

Do not turn this file into a second full API manual.

Repository Layout

  • src/ax/ - main library package: @ax-llm/ax
  • src/ai-sdk-provider/ - Vercel AI SDK provider: @ax-llm/ax-ai-sdk-provider
  • src/examples/ - runnable examples and integration-style demos
  • website/ - Hugo documentation site, deployed to axllm.dev via GitHub Pages
  • docs/ - canonical markdown docs

Canonical Docs

docs/ holds the canonical maintainer markdown. The public site under website/ is built separately with npm run website:build (TypeDoc API markdown → npm run website:prepare → Hugo → Pagefind); never edit the generated copies under website/.generated/ or website/public/.

Current Project Defaults

Prefer the modern factory-style API:

  • use ai(...), ax(...), agent(...), flow(...), optimize(...)
  • prefer string signatures and s(...)
  • prefer fn(...) for tools

Avoid deprecated patterns in new code:

  • new AxAI(...)
  • template literal forms like ax`...` and s`...`

Use current models

When adding or updating any example, default, or test that names a model, pick a current generation — newer beats biggest. The provider model enums are the source of truth for what's current: src/ax/ai/openai/chat_types.ts, src/ax/ai/google-gemini/types.ts, src/ax/ai/anthropic/types.ts. Choose a recent member; a newer small/cheap model (e.g. gpt-5.4-mini, gemini-3.5-flash) is preferred over an old flagship (gpt-4o, gemini-2.x), and never pin a dated -preview when a stable newer one exists. Don't leave examples sitting on an old generation once a newer one lands in the enums.

Skills As Subsystem Docs

Use the skill files in src/ax/skills/ as the primary subsystem documentation:

  • src/ax/skills/ax-llm.md - top-level Ax quick reference
  • src/ax/skills/ax-ai.md - AI providers, models, presets, embeddings, thinking
  • src/ax/skills/ax-audio.md - conversational audio input/output in .chat()
  • src/ax/skills/ax-signature.md - signatures, field types, validation, fluent API
  • src/ax/skills/ax-gen.md - generators and structured output
  • src/ax/skills/ax-agent.md - agents, runtime, discovery, delegation, shared fields
  • src/ax/skills/ax-agent-optimize.md - agent.optimize(...), evals, judges, artifacts
  • src/ax/skills/ax-flow.md - workflows and orchestration
  • src/ax/skills/ax-mcp.md - native MCP clients, transports, auth, catalogs, tasks, subscriptions, and Ax integration
  • src/ax/skills/ax-event-runtime.md - event ingestion, wake/resume, continuations, stores, and sinks
  • src/ax/skills/ax-gepa.md - Pareto optimization
  • src/ax/skills/ax-learn.md - self-improving agent patterns

Read the full file on GitHub · 150 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 150 lines · 1,548 tokens per session scan A e216ef241ab6

Subscribe to this mod's changes

ax AGENTS.md is an instructions file published in the GitHub repository ax-llm/ax (2,890 stars, last pushed 2d ago), licensed Apache-2.0. It adds 1,548 tokens to every session, about $0.0077 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.