graflow AGENTS.md

Repository instructions for GraflowAI/graflow, a Python workflow system with task execution, queues, workers, APIs, human feedback, and tracing.

In plain words
What is it for?
Working in the Graflow repository: locating modules and tests, installing dependencies, formatting code, running lint checks, and following its development guidelines.
Why use it?
They give coding agents the project’s expected structure, commands, naming style, and testing approach before making changes.

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/graflowai/graflow/agents-md
Clone the repo
git clone --depth 1 https://github.com/GraflowAI/graflow

Made for: Codex, OpenCode.

Per session 757 This file is loaded in full into every session.
When invoked 757 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.00757 $0.00757
Opus 5 $0.00378 $0.00378
Sonnet 5 $0.00151 $0.00151
Haiku 4.5 $0.00076 $0.00076

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

Security

Grade A, and why

graflow 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 · 52 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

  • graflow/: Source code.
    • core/: Workflow engine, tasks, graph, decorators, handlers, checkpoints.
    • channels/: In‑memory/Redis channels and typing helpers.
    • queue/: In‑memory/Redis task queues.
    • coordination/: Coordinators, executors, multiprocessing/Redis integration.
    • worker/: Worker entrypoints and handlers.
    • hitl/: Human-in-the-Loop (HITL) feedback management.
    • llm/: LLM integration and agent management.
    • trace/: Tracing and observability (Langfuse integration).
    • api/: REST API for workflow management and HITL feedback.
    • serialization/: Task serialization utilities.
    • debug/: Debugging and visualization tools.
    • utils/, exceptions.py, __init__.py.
  • tests/: Pytest suite by domain (e.g., core/, queue/, scenario/, integration/).
  • examples/: Runnable examples (e.g., examples/simple_workflow_example.py).
  • docs/: Architecture notes and dev plans.

Build, Test, and Development Commands

  • make install / make install-dev: Sync deps with uv (dev adds lint/test tools).
  • make format: Auto‑fix common style issues via ruff.
  • make lint: Run ruff and mypy.
  • make check: Type check only (mypy).
  • make test: Run unit tests (pytest -v).
  • make test-cov: Run tests with coverage report.
  • make check-all: Format, lint, and test.
  • make py examples/simple_test.py: Run a file with PYTHONPATH=. using uv.

Prereqs: Python 3.11+, uv installed. Examples using Redis assume a local Redis at localhost:6379.

Coding Style & Naming Conventions

  • Indentation: 4 spaces; max line length: 120.
  • Types: Add explicit annotations (mypy is strict on untyped defs).
  • Naming: snake_case for functions/vars, PascalCase for classes, module names lowercase.
  • Imports: Group and sort (ruff/isort settings; first‑party is graflow).

Testing Guidelines

  • Framework: pytest. Tests live under tests/ and follow test_*.py naming.
  • Markers: @pytest.mark.integration for external‑service tests (e.g., Redis). Example: uvx pytest -m 'not integration'.
  • Run: make test locally before PRs. Use make test-cov for coverage when changing core logic.

Read the full file on GitHub · 52 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 · 52 lines · 757 tokens per session scan A 1f7b498e0336

Subscribe to this mod's changes

graflow AGENTS.md is an instructions file published in the GitHub repository GraflowAI/graflow (41 stars, last pushed 19d ago), licensed Apache-2.0. It adds 757 tokens to every session, about $0.0038 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.

Related

Other instructions, from other repositories

LeAgent AGENTS.md

Instructions for vixues/LeAgent, covering leagent development guidelines, project overview, architecture, execution topology (one kernel, many ingresses) and surface map (where things live).

vixues/LeAgent · 6,799 tokens

do-it AGENTS.md

Instructions for tdwhere123/do-it, covering agents.md, file rules, repository, source of truth vs build artifacts and closed-set contracts.

tdwhere123/do-it · 873 tokens

opendigitalproductfactory AGENTS.md

AGENTS.md instructions for OpenDigitalProductFactory/opendigitalproductfactory, covering dpf — agent rulebook, 1. first principles, 2. project architecture, 3. branching, commits & prs and 4. verification — build gate (mandatory).

OpenDigitalProductFactory/opendigitalproductfactory · 5,667 tokens

moo-tasks AGENTS.md

Instructions for dizlexic/moo-tasks, covering agents.md, 1. what is the moo tasks board?, 2. connecting your agent, 3. available mcp tools and 4. recommended workflow for agents.

dizlexic/moo-tasks · 3,550 tokens

opendigitalproductfactory copilot-instructions.md

Copilot instructions for OpenDigitalProductFactory/opendigitalproductfactory: Read /AGENTS.md at the repo root before any work in this project. It is the canonical rulebook; tool-specific files in this repo are pointers to it.

OpenDigitalProductFactory/opendigitalproductfactory · 40 tokens

opendigitalproductfactory CLAUDE.md

Claude Code instructions for OpenDigitalProductFactory/opendigitalproductfactory, a project described as: This is the official open digital product factory.

OpenDigitalProductFactory/opendigitalproductfactory · 32 tokens