Agents Playbook

Glossary

Short definitions for the terms used across this playbook.

View raw .md

Glossary

Short definitions for the terms used across this playbook.

TermDefinition
ADRArchitecture Decision Record. Numbered, append-only doc capturing one decision. Source of truth for codebase structure.
RFCRequest for Comment. ADR-with-review-window, used for changes to public contracts. Promotes to ADR on acceptance.
BoundaryAnywhere bytes enter the process from outside the trust boundary: HTTP, IPC, JSON-RPC, file IO, env, message bus.
ContractA schema (typically Zod / Pydantic / Protobuf) that defines the shape crossing a boundary.
Contract packageThe dependency-free package that owns all shared schemas + the error model.
Stable codeA string error code (\<NS\>_\<REASON\>, all caps) that clients pattern-match on. Append-only.
AppErrorThe single base error class. Every other error subclasses it.
Routing tableThe AGENTS.md mapping from "I want to change X" to "edit package Y".
PR-intent manifestYAML block in PR description: adds:, changes:, removes:, tests:, docs:. Verified by a gate.
removes-listThe removes: entries in the manifest. Removing another author's exported symbol requires one.
Sub-unitOne discrete, shippable change. One sub-unit per session.
Phased PRA long initiative shipped as a chain of phase PRs, each merged with --merge --admin.
Verify-firstConfirm state (issue open, branch fresh, file path real) before acting.
TombstoneStatus block prepended to a retired doc indicating it is no longer active. Body kept for trail.
Completeness contractPer-screen rule that no TODO/disabled tab/empty body ships.
Hermetic testIn-process test that reproduces a bug without external services. Preferred over E2E for repro/lock.
Property-based testA test that asserts a law over generated inputs (round-trip, idempotence, injectivity…) and shrinks failures to a minimal counterexample.
FuzzingThrowing hostile / malformed bytes at a parser or crypto boundary; the bar is a typed error, never a crash or silent accept.
Adversarial bug-huntFind → refute → reproduce loop: orthogonal lens finders, independent skeptics that try to refute each candidate, a failing repro to confirm.
Intent testA test that codifies current behavior as deliberate. Its presence means a "bug" is actually intended — check for one before "fixing".
Fail-loud defaultA mandatory dependency whose unwired default throws instead of silently no-op'ing, so missing production wiring fails fast rather than shipping green.
Verification ledgerA done-report that separates automated-verified (a check ran + passed) from claimed (believed, not run) and lists known-not-done.
Merkle malleabilityTree builds where duplicating a lone node lets two different input sets share one root (CVE-2012-2459). Fixed by domain separation (RFC 6962) + promoting lone nodes.
Quality gatesFast structural checks (file size, no any, named exports, intl, tokens). Run pre-commit + CI.
SanityCross-cutting periodic audit. Generates a report; CI fails on regressions.
Shrink-only baselineGate config: existing offenders are baselined, new violations fail. Baseline can only shrink.
Break-glassTime-boxed admin role elevation with signed audit trail.
Consent (in security)Scoped, time-boxed user approval for a specific action. Distinct from role elevation.
Egress allowlistDefault-deny outbound network policy; only allowlisted destinations resolve.
SealerThe key that encrypts secrets at rest. Rotatable.
Audit ledgerAppend-only signed log of privileged operations. Verifiable via batch signature / Merkle anchor.
DSARData Subject Access Request. GDPR-style export / delete request.
Legal holdFlag that suspends retention for a subject under investigation.
Whitelabel / OEMPer-tenant brand kit + plan presets that swap product name, logo, palette at build / runtime.
MEMORY patternOne-fact-per-file persistent agent memory with an index file (MEMORY.md).
OKF (Open Knowledge Format)Open standard (Google Cloud, v0.1) for agent-readable knowledge: a directory of markdown files + YAML frontmatter, type the only required field, index.md + markdown-link graph. Vendor-neutral, no SDK.
Sub-agentScoped specialist agent delegated for a fan-out task.
Slash commandPalette-invoked workflow body.
Goal modeStop hook with a condition; agent works until the condition holds.

On this page