Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# AGENTS.md

## Documentation and skills index

Key references for navigating this project:

- `README.md` -- project overview and local development prerequisites.
- `Cargo.toml` -- workspace members, shared dependencies, and repo metadata.
- `crates/` -- implementation crates and crate-local manifests.
- `proto/` -- protobuf contracts and wire-format definitions.
- `scripts/` -- repo automation and helper scripts.
- `Makefile.toml` -- common task entry points.

## Response priorities

- Start with high-level recommendations before implementation details.
- Keep recommendations short, opinionated, and tied to tradeoffs.
- If multiple paths exist, present one default path and one fallback.

## Clarification Before Action

- If ambiguity can affect correctness, security, scope, or destination path,
ask before acting.
- When unknown terms or domain concepts appear, ask for an explanation
and document them in the repository only when a canonical location exists.
- Low-risk ambiguity in instructions may be assumed:
state one explicit assumption and proceed with the smallest reversible change.
- Ambiguity about technical meaning, domain semantics, or definitions
is never low-risk. Always ask for clarification and document it if necessary.

## Evidence-Based Debugging and Communication

- Avoid overconfidence.
Do not present uncertain conclusions as facts.
- State uncertainty explicitly when evidence is incomplete.
- Present multiple viable options when tradeoffs exist; let the user choose.
- Treat root-cause analysis as hypothesis-first until verified.
- Use evidence-based language:
prefer "might", "could", or "one possibility is" before validation.
- Do not claim causality without proof from logs, traces, tests,
debugger output, or reproducible steps.
- Follow evidence-first debugging:
collect data (including targeted logs when needed)
before proposing or applying a fix.

## Dedicated domain behavior (Interop)

- Frame recommendations in interop terms: proofs, witnesses, bridge safety,
settlement correctness, and operational reliability.
- Prefer changes that improve safety invariants, wire compatibility,
observability, and rollback clarity over local optimizations.
- Call out likely blast radius across crates, RPC, gRPC, and protobuf
boundaries, serialization formats, and end-to-end flows before proposing
deep refactors.

## Collaboration norms

- Confirm assumptions in one sentence when requirements are ambiguous,
then proceed with the safest minimal change.
- Surface risks early (consensus/security/regression/perf)
and suggest one concrete verification step.
- Do not run non-read-only git operations
(e.g., `add`, `rm`, `mv`, `checkout`, `restore`, `commit`, `push`)
without explicit user approval.
Read-only commands (`status`, `diff`, `log`, `show`) are always allowed.
- Repo-local skills, if introduced, live in `.agents/skills/`.
- Express skill dependencies explicitly in prose; do not assume automatic
dependency loading.
- `agglayer-ai-skills` must be installed and enabled so its required task skills can be loaded in the current session before doing any work in this repository.
- If the plugin or the skills required for the current task are unavailable, stop immediately and ask the user to install or enable them before any further clarification, planning, or repository exploration.
- This availability gate takes precedence over the `Clarification Before Action` section. Do not proceed until the plugin and task-required skills are available.
- Do not reference required docs or directories in `AGENTS.md` until they
exist.
- Precedence: when rules conflict,
favor the Clarification Before Action section, except for the `agglayer-ai-skills` availability gate above.
Loading