Foam-Agent: Instructions file for Codex

AGENTS.md

Foam-Agent AGENTS.md is an instructions file for Codex, OpenCode from csml-rpi/Foam-Agent. It costs 1,171 tokens per session, scanned A, original, MIT.

Instructions for Foam-Agent, a multi-agent system that turns natural-language requests into Computational Fluid Dynamics simulations using Foundation OpenFOAM v10.

In plain words
What is it for?
Use it to set up Foam-Agent, run simulations with prompts or custom meshes, run tests, or start its MCP server.
Why use it?
It explains the required OpenFOAM version, setup, commands, and incompatibilities that could otherwise produce unusable simulation files.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is csml-rpi/Foam-Agent's own configuration. It tells Codex and OpenCode how to work on Foam-Agent itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything Foam-Agent configures →

Reuse

Borrowing it

Nothing to install: this file belongs to csml-rpi/Foam-Agent. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/csml-rpi/Foam-Agent/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/csml-rpi/Foam-Agent

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for Foam-Agent AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/csml-rpi/foam-agent/agents-md/github.svg)](https://agentmods.dev/instructions/csml-rpi/foam-agent/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/csml-rpi/foam-agent/agents-md"><img src="https://agentmods.dev/badge/instructions/csml-rpi/foam-agent/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for Foam-Agent AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/csml-rpi/foam-agent/agents-md"><img src="https://agentmods.dev/badge/instructions/csml-rpi/foam-agent/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,171 This file is loaded in full into every session.
When invoked 1,171 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.01171 $0.01171
Opus 5.5 $0.00468 $0.00468
Sonnet 5.5 $0.00234 $0.00234
Haiku 4.5 $0.00117 $0.00117

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

Security

Grade A, and why

Foam-Agent 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 · 60 lines

How it starts

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

Working on Foam-Agent

Foam-Agent automates CFD simulation through LangGraph, OpenFOAM tutorial retrieval, and model-backed services. See README for setup, usage for configuration, and MCP for tool contracts.

Development Commands

conda env create -f environment.yml
conda activate FoamAgent
python -m pip install 'torch==2.5.1' --index-url https://download.pytorch.org/whl/cpu
python -m pip install -c constraints.txt -e '.[mesh]'
python scripts/doctor.py
python foambench_main.py --output ./output --prompt_path ./user_requirement.txt
pytest tests/ -v
foamagent-mcp --transport http --host 0.0.0.0 --port 7860

The Conda file bootstraps Python 3.12.9 and pip; application dependencies are installed from pyproject.toml using constraints.txt. Docker builds install CPU Torch and bundle the default embedding weights. Source the intended OpenFOAM runtime before local execution.

Code Map

Location Responsibility
src/main.py, src/router_func.py Graph construction, initialization, and routing
src/nodes/ Thin orchestration wrappers
src/services/ Planning, file generation, meshing, execution, review, visualization, and case import
src/config.py, src/openfoam_target.py Configuration and target/runtime/corpus contracts
src/utils.py LLM clients, RAG, graph state, and shared file/process helpers
src/models.py Import manifests and structured existing-case plans
src/mcp/ Tool schemas, server, and shared startup logic
src/translation/ Legacy Foundation-to-ESI compatibility
database/<target>/ Target-specific raw tutorials and FAISS indices
database/script/, scripts/ Corpus builders and verification tools
examples/, docs/, tests/ Sample inputs, user guides, and automated regressions

Generated-file models live in utils.py; planning/rewrite models are defined in their services. GraphState is the schema merged by LangGraph. Nodes may mutate nested Config objects, so do not assume state dictionaries are shared unchanged.

Read the full file on GitHub · 60 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 Changed · +2 lines · +71 tokens per session b684d8c3b53f
  2. 6d ago Changed · -103 lines · -1,413 tokens per session 15c088323059
  3. 1mo ago Changed · +27 lines · +883 tokens per session 2895319193b3
  4. 2mo ago First seen · 134 lines · 1,630 tokens per session scan A 380e69ce8141

Subscribe to this mod's changes

Foam-Agent AGENTS.md is an instructions file published in the GitHub repository csml-rpi/Foam-Agent (363 stars, last pushed 3d ago), licensed MIT. It adds 1,171 tokens to every session, about $0.0047 per session on Opus 5.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.

Related

Foam-Agent AGENTS.md compared with instructions from other repositories

Foam-Agent AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
Foam-Agent AGENTS.mdcsml-rpi/Foam-AgentInstructions file3633d agoMITA1,171Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode