ag-ui AGENTS.md

A set of AGENTS.md instructions for the AG-UI repository, including its AG-UI and A2UI quickstarts and Nx workspace rules. Nx is a tool for managing projects and tasks in a shared code repository.

In plain words
What is it for?
Use it when adding A2UI to AG-UI applications, creating a quickstart, running builds or tests, or investigating Nx configuration and project-graph problems.
Why use it?
It tells coding agents which repository tools and project information to use, reducing incorrect commands and misplaced changes in a multi-project workspace.

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/ag-ui-protocol/ag-ui/agents-md
Clone the repo
git clone --depth 1 https://github.com/ag-ui-protocol/ag-ui

Made for: Codex, OpenCode.

Per session 306 This file is loaded in full into every session.
When invoked 306 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.00306 $0.00306
Opus 5 $0.00153 $0.00153
Sonnet 5 $0.00061 $0.00061
Haiku 4.5 $0.00031 $0.00031

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

Security

Grade A, and why

ag-ui 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 · 18 lines

What it actually says

General Guidelines for working with Nx

  • For requests to add A2UI rendering to AG-UI applications or to scaffold an AG-UI + A2UI quickstart, use skills/ag-ui-a2ui-integration/SKILL.md.
  • When running tasks (for example build, lint, test, e2e, etc.), always prefer running the task through nx (i.e. nx run, nx run-many, nx affected) instead of using the underlying tooling directly
  • You have access to the Nx MCP server and its tools, use them to help the user
  • When answering questions about the repository, use the nx_workspace tool first to gain an understanding of the workspace architecture where applicable.
  • When working in individual projects, use the nx_project_details mcp tool to analyze and understand the specific project structure and dependencies
  • For questions around nx configuration, best practices or if you're unsure, use the nx_docs tool to get relevant, up-to-date docs. Always use this instead of assuming things about nx configuration
  • If the user needs help with an Nx configuration or project graph error, use the nx_workspace tool to get any errors
  • For Nx plugin best practices, check node_modules/@nx/<plugin>/PLUGIN.md. Not all plugins have this file - proceed without it if unavailable.
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 · 18 lines · 306 tokens per session scan A 006ab93fb059

Subscribe to this mod's changes

ag-ui AGENTS.md is an instructions file published in the GitHub repository ag-ui-protocol/ag-ui (15,674 stars, last pushed yesterday), licensed MIT. It adds 306 tokens to every session, about $0.0015 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.