yaml-workflow AGENTS.md

A set of instructions for AI coding agents working on yaml-workflow, a Python tool that runs tasks described in YAML files. It explains the project, setup, code layout, testing, formatting, type checking, and documentation build.

In plain words
What is it for?
Use it to guide setup, implementation, tests, lint checks, type checks, and documentation work in the yaml-workflow repository.
Why use it?
It gives coding agents the project-specific rules and commands they need, reducing guesswork when changing or checking the code.

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/orieg/yaml-workflow/agents-md
Clone the repo
git clone --depth 1 https://github.com/orieg/yaml-workflow

Made for: Codex, OpenCode.

Per session 968 This file is loaded in full into every session.
When invoked 968 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.00968 $0.00968
Opus 5 $0.00484 $0.00484
Sonnet 5 $0.00194 $0.00194
Haiku 4.5 $0.00097 $0.00097

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

Security

Grade A, and why

yaml-workflow 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 2d 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 · 89 lines

How it starts

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

AGENTS.md

Guidance for AI coding agents (Claude Code, Cursor, Copilot, and others) working in the yaml-workflow repository. Humans: see CONTRIBUTING.md.

What this project is

yaml-workflow is a lightweight Python workflow engine that runs tasks defined in YAML — shell, Python, file, template, HTTP, and batch — with Jinja2 templating, parallel execution, and resumable file-based state. The core runtime depends on only PyYAML and Jinja2; keep it that way — optional features (MCP server, web dashboard) live behind extras.

Setup

python -m venv .venv
source .venv/bin/activate            # Windows: .venv\Scripts\activate
pip install -e ".[dev,test,doc]"

Build, test, and lint

pytest tests/ --benchmark-disable                      # run the test suite
pytest tests/test_shell_tasks.py::test_shell_basic     # run a single test
black --check src tests                                 # format check
isort --check-only --profile black src tests            # import-order check
mypy src                                                # type check
mkdocs build                                            # build the docs site

Apply formatting with black src tests && isort --profile black src tests. Run everything through the virtualenv (source .venv/bin/activate). CI runs black + isort + mypy as a gate on Ubuntu / Python 3.12 before the tests, and runs the test suite across Linux/macOS/Windows and Python 3.10–3.13 — so a change must pass all four checks locally.

Code layout

  • src/yaml_workflow/engine.py — the workflow engine (parse, template, run, state).
  • src/yaml_workflow/cli.py — CLI: run, list, validate, visualize, init, serve, serve-mcp.
  • src/yaml_workflow/tasks/ — built-in task types; register new ones with @register_task.
  • src/yaml_workflow/validator.py — workflow validation (yaml-workflow validate).
  • src/yaml_workflow/mcp_server.py — MCP server exposing workflows as agent tools.
  • src/yaml_workflow/examples/ — bundled example workflows (copied by yaml-workflow init).
  • schema/workflow-schema.json — JSON Schema for the workflow YAML format.
  • tests/ — pytest suite, one file per module.
  • docs/ — MkDocs (Material) documentation source.

Read the full file on GitHub · 89 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. 2d ago First seen · 89 lines · 968 tokens per session scan A 84feb575e554

Subscribe to this mod's changes

yaml-workflow AGENTS.md is an instructions file published in the GitHub repository orieg/yaml-workflow (3 stars, last pushed 9d ago), licensed MIT. It adds 968 tokens to every session, about $0.0048 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-31.