agentleFS
GitHubKnown publishergithub/squad/.github/skills/iterative-retrieval/SKILL.md

iterative-retrieval

Skill3.4k starsChanged 2 months agoMITView on GitHub

Max-3-cycle protocol for agent sub-tasks with WHY context and coordinator validation. Use when spawning sub-agents to complete scoped work.

41 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use project-guidelines-example, configure-ecc and 6 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • HABUBUSSSkill

    project-guidelines-example

    Also in 14 projects that use this

  • royaluniondesign-sysSkill

    configure-ecc

    Interactive installer for Everything Claude Code — guides users through selecting and installing skills and rules to user-level or project-level directories, verifies paths, and optionally optimizes installed files.

    Also in 9 projects that use this

  • junimnjwSkill

    ralphinho-rfc-pipeline

    RFC-driven multi-agent DAG execution pattern with quality gates, merge queues, and work unit orchestration.

    Also in 9 projects that use this

  • royaluniondesign-sysSkill

    content-hash-cache-pattern

    Cache expensive file processing results using SHA-256 content hashes — path-independent, auto-invalidating, with service layer separation.

    Also in 12 projects that use this

  • junimnjwSkill

    carrier-relationship-management

    Codified expertise for managing carrier portfolios, negotiating freight rates, tracking carrier performance, allocating freight, and maintaining strategic carrier relationships. Informed by transportation managers with 15+ years experience. Includes scorecarding frameworks, RFP processes, market intelligence, and compliance vetting. Use when managing carriers, negotiating rates, evaluating carrier performance, or building freight strategies.

    Also in 7 projects that use this

  • mstuder-slalomSkill

    springboot-security

    Spring Security best practices for authn/authz, validation, CSRF, secrets, headers, rate limiting, and dependency security in Java Spring Boot services.

    Also in 14 projects that use this

The file

We split this skill into the rules it gives an agent

10 rules. 0 are common, 10 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 31 edited versions we read keep these.

  • 10

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every agent spawn must include the following four sections.

    line 20
  2. Distinctive:

    Before accepting agent output and closing an issue, the coordinator must check:

    line 67
  3. Distinctive:

    If any item fails → do not accept.

    line 75
  4. Distinctive:

    Retry (cycle N+1): when:

    line 81
  5. Distinctive:

    Before any agent creates a GitHub issue, it must search for existing open issues to avoid duplicates.

    line 97
  6. Distinctive:

    If an open issue already covers the same problem → comment on it instead of creating a new one.

    line 105
  7. Distinctive:

    If no duplicate → proceed to create the issue.

    line 106
  8. Distinctive:

    Use 2–3 representative keywords from the planned issue title as the search query.

    line 107
  9. Distinctive:

    Every research or analysis task completed under this protocol MUST end with at least one concrete action before the cycle is closed.

    line 113
  10. Distinctive:

    If no action is warranted, the agent must explicitly state why and get coordinator sign-off.

    line 122

“Common” is measured: kept by at least 6 in 10 of the 31 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Iterative Retrieval Skill

Squad agents frequently spawn sub-agents to complete scoped work. Without structure, these handoffs become vague, cycles multiply, and outputs land without being checked. The Iterative Retrieval Pattern caps cycles at 3, mandates WHY context in every spawn, and requires the coordinator to validate agent output before closing an issue.


Spawn Prompt Template

Every agent spawn must include the following four sections. Copy and fill in the template:

## Task
{What you need done — concrete and bounded}

## WHY this matters
{The motivation and context. What system or user goal does this serve? What breaks if skipped?}

## Success criteria
{How you will know the output is correct. Be explicit — list acceptance criteria, not vibes.}
Example:
- [ ] File X exists and contains Y
- [ ] No regressions in existing tests
- [ ] PR is open targeting main with description matching the issue

## Escalation path
{What the agent should do if uncertain or stuck. "Stop and ask me" is valid.}
Example:
- If requirements are ambiguous → stop, comment on the issue, set label status:needs-decision
- If blocked by a dependency → label status:blocked, explain in a comment
- If 3 cycles exhausted without resolution → write a summary to inbox and surface to coordinator

3-Cycle Protocol

CycleDescriptionExit condition
1Initial attemptDone → coordinator validates. Incomplete → surface delta.
2Targeted retry with specific correctionsDone → coordinator validates. Incomplete → one more.
3Final attempt with all context from cycles 1–2Done or escalate — no cycle 4.

Rules

  1. After each cycle, the coordinator evaluates the output against the success criteria before accepting it or spawning the next cycle.
  2. Objective context forward: each subsequent spawn includes a summary of what was tried and what is still missing — not just a repeat of the original task.
  3. Cycle 3 exhausted → escalate: write a summary to .squad/decisions/inbox/, label the issue status:needs-decision, and notify the user.

Coordinator Validation Checklist

Before accepting agent output and closing an issue, the coordinator must check:

  • All success criteria from the spawn prompt are met
  • PR exists and description matches the issue (if code work)
  • No obvious regressions (grep for TODO/FIXME introduced, build passes)
  • Agent did not silently skip parts of the task
  • If the agent reported uncertainty — was it resolved or escalated?

If any item fails → do not accept. Spawn cycle N+1 (up to cycle 3) with specific deltas.


When to Escalate vs Retry

Retry (cycle N+1) when:

  • Output is structurally correct but missing specific items
  • Agent misunderstood scope (provide more context and re-run)
  • Partial success — clearly identified remaining delta

Escalate when:

  • Requirements are fundamentally unclear (decision needed)
  • 3 cycles complete without convergence
  • Agent returned conflicting results across cycles
  • Task requires elevated permissions or external action
  • The work depends on another issue that isn't done yet

Issue Dedup Check (Mandatory)

Before any agent creates a GitHub issue, it must search for existing open issues to avoid duplicates.

# Check for existing open issues before creating a new one
gh issue list --search "<keywords from your issue title>" --state open
  • If an open issue already covers the same problem → comment on it instead of creating a new one.
  • If no duplicate → proceed to create the issue.
  • Use 2–3 representative keywords from the planned issue title as the search query.

Mandatory Output Requirement (Research-Then-Execute)

Every research or analysis task completed under this protocol MUST end with at least one concrete action before the cycle is closed. Acceptable follow-up actions:

  • GitHub issue created documenting the findings and next steps
  • PR opened implementing a recommendation
  • Decision recorded in .squad/decisions/inbox/
  • Documented recommendation with a named assignee and due date

Pure analysis reports without actionable follow-up will be rejected during triage. If no action is warranted, the agent must explicitly state why and get coordinator sign-off.


Anti-Patterns

  • Spawning without WHY — agents can't prioritise trade-offs without motivation context.
  • Accepting output without validating — one failed check avoids merging broken work.
  • Cycle 4+ — if 3 cycles haven't converged, the problem is in the requirements, not the agent.
  • Vague success criteria — "looks good" is not a criterion. Use checkboxes.
  • Forwarding WHAT without delta — cycle 2+ prompts must include what cycle 1 got wrong.
  • Creating issues without dedup check — always search before creating.
  • Research without action — delivering analysis with no issue, PR, decision, or assignee is incomplete work.

Examples

Good spawn prompt

## Task
Add an "Iterative Retrieval Protocol" section to `.squad/agents/coordinator/charter.md` explaining
the 3-cycle rule, WHY format, and validation checklist.

## WHY this matters
The coordinator spawns sub-agents on every round. Without a documented protocol, agents run unbounded
cycles and outputs go unvalidated — leading to stale issues and silent failures.

## Success criteria
- [ ] Section "Iterative Retrieval Protocol" exists in charter.md
- [ ] Section documents max-3-cycles rule
- [ ] Section documents WHY format requirement
- [ ] Section contains validation checklist (at least 4 items)
- [ ] No other sections of charter.md are modified

## Escalation path
If the charter.md format is unclear, check another agent charter as a reference.
If uncertain about content, stop and surface to coordinator.

Bad spawn prompt (don't do this)

Update the coordinator charter with the iterative retrieval stuff.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.