agentmods.dev

canary: Instructions file for Claude Code

AGENTS.md

canary AGENTS.md is an instructions file for Claude Code, Codex, OpenCode from bop-clocktower/canary. It costs 27,591 tokens per session, scanned A, original, MIT.

Repository instructions for Canary, an AI tool that turns written requirements into test code. They describe its documentation, architecture, diagrams, and project structure.

In plain words
What is it for?
Use them when working in the Canary repository, especially on documentation, diagrams, harness integration, or its self-healing testing process.
Why use it?
They give coding agents the project-specific rules and background needed to make consistent changes.

Instructions file for Claude CodeCodexOpenCode

Written for Claude Code and Codex and OpenCode: PreToolUse hook event, but also the file is AGENTS.md. Also seen: reads .claude/ paths; mentions .claude-plugin; mentions subagents.

This is bop-clocktower/canary's own configuration. It tells Claude Code, Codex and OpenCode how to work on canary 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 canary configures →

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is git worktree add ../canary-entropy origin/main --detach.

not rated 5repo +1 changed today A scan 27,591 tokens original MIT
View source ↗ bop-clocktower/canary
Reuse

Borrowing it

Nothing to install: this file belongs to bop-clocktower/canary. 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/bop-clocktower/canary/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/bop-clocktower/canary

Made for: Claude Code, 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 canary AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/bop-clocktower/canary/agents-md/github.svg)](https://agentmods.dev/instructions/bop-clocktower/canary/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/bop-clocktower/canary/agents-md"><img src="https://agentmods.dev/badge/instructions/bop-clocktower/canary/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 canary AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/bop-clocktower/canary/agents-md"><img src="https://agentmods.dev/badge/instructions/bop-clocktower/canary/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 27,591 This file is loaded in full into every session.
When invoked 27,591 The same file — it is already loaded in full.
Security scan A 1 finding. 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.27591 $0.27591
Opus 5.5 $0.11036 $0.11036
Sonnet 5.5 $0.05518 $0.05518
Haiku 4.5 $0.02759 $0.02759

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

Security

Grade A, and why

canary AGENTS.md scanned grade A with 1 finding 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 today.

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.

Runs shell commandslowCapability

Expected in a hook, worth knowing in a rule or an instructions file.

threshold of 10 doing it (#622). `runCapture` wraps `spawnSync`, which returns
AGENTS.md · 1,811 lines

How it starts

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

Canary Knowledge Map

Project Overview

Canary is an AI-powered test automation agent that transforms natural language requirements into high-quality, framework-aware test code. It follows strict harness engineering practices for layer isolation and architectural integrity.

Documentation

  • Wiki Home: [Home][wiki-home]
  • Architecture Deep Dive: [Architecture Deep Dive][arch-deep-dive]
  • Harness Integration: [Harness Integration][harness-int]
  • Harness + Canary Routing & Ownership: Integration Guide
  • LLM Configuration: [LLM Providers][llm-config]
  • Self-Healing Loop: [Self-Healing Loop][self-healing]
  • Main README: README.md
  • Contributing: CONTRIBUTING.md — thin pointer to this file, plus the one thing a contributor cannot discover from it: fork PRs currently cannot pass a required check (#843)
  • Roadmap: docs/roadmap.md
  • State: CANARY_STATE.md
  • Engineering Learnings: CANARY_LEARNINGS.md

Diagrams

Architecture and flow diagrams live as Mermaid fenced blocks inside the wiki page they document (docs/wiki/**) — never as checked-in images. The GitHub Wiki renders Mermaid natively, so the source stays diff-reviewable, versioned with the code it describes, and editable without a drawing tool.

Rules:

  • Put the diagram next to the prose it illustrates. A diagram in a separate file drifts from the text within one release.
  • Update the diagram in the same PR as the behaviour it shows. A stale diagram is worse than none: it is trusted more and checked less.
  • Diagram what exists, not what is planned. If a component is aspirational, say so in prose instead of drawing it.
  • CI renders every chart (Docs Lint → Wiki diagrams render). The Wiki renders Mermaid natively, which means a malformed chart ships silently — the job turns that into a PR-time failure. Preview locally with:

Read the full file on GitHub · 1,811 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. today Changed · +6 lines · +103 tokens per session c76c51d10323
  2. 2d ago Changed · +7 lines · +128 tokens per session bea6f46a6c9f
  3. 4d ago Changed · +50 lines · +941 tokens per session a1494ec8a69e
  4. 5d ago Changed · +7 lines · +146 tokens per session d5f5eefe07da
  5. 8d ago Changed · +7 lines · +136 tokens per session c5914f31528e
  6. 11d ago Changed · +1 lines · +36 tokens per session 8b2e9338cfc4
  7. 12d ago Changed · +3 lines · +57 tokens per session efb224f74221
  8. 17d ago Changed · +36 lines · +592 tokens per session afa91000687e
  9. 19d ago Changed · +42 lines · +765 tokens per session 00240d7fae6e
  10. 20d ago First seen · 1,652 lines · 24,687 tokens per session scan A 4a9c2f37cfbe

Subscribe to this mod's changes

canary AGENTS.md is an instructions file published in the GitHub repository bop-clocktower/canary (5 stars, last pushed yesterday), licensed MIT. It adds 27,591 tokens to every session, about $0.1104 per session on Opus 5.5. A static security scan graded it A with 1 finding (runs shell commands). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Testing
Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

vscode model-prompts.instructions.md

Model-specific prompt authoring and registry guidelines.

microsoft/vscode · 2,022 tokens