Bean Drain

Skill id: bean-drain

Generated from JSON Schema — do not edit by hand. Run bun run cat-harness-tools/scripts/gen-schema-docs.ts.

Input

What a drain starts from: every bean copy to read, the agents that may hold a bean and how each is recognised, what each owner already holds, the activity window, and where the queue is written. Skill work-plan/skills/work-plan/bean-drain.md, bean n7x7.

FieldTypeRequiredDescription
copiesarrayyesEVERY copy of the bean store, not only the one this checkout mounts. While there is more than one, a claim is a plain commit on each.
agentsarrayyesWho may be draining, told apart by commit author on the bean branch. An author matching none of these is treated as another agent.
holdingsobjectyesOwner (thread or agent name) to the bean ids it already holds, used to group new beans with the owner already working in that area. {} on a first run.
windowHoursintegeryesA commit to a bean by another agent within this window means skip it. (default: 24, min: 1)
queueFilestringyesWhere the queue is written for every drainer to read, e.g. drain-queue/open-beans-.md in the shared project files. (minLength: 1)
reposarraynoRepositories whose open PRs are searched for a bean id before a claim. Defaults to the repos of copies, plus every repo the drained beans’ PRs land in.

copies[]

FieldTypeRequiredDescription
repostringyesowner/name, e.g. litlfred/folio-assistant. (pattern: ^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$)
refstringyesThe branch holding the store, e.g. cat/cat-harness/beans, or main. (minLength: 1)
defsstringyesDirectory of bean files on that ref, e.g. beans/defs. (minLength: 1)

agents[]

FieldTypeRequiredDescription
namestringyese.g. cloud, agy. (minLength: 1)
authorsarrayyesCommit author strings, ‘Name ', e.g. 'Carl Leitner <litlfred@fenugreek.home>'.
selfbooleanyestrue for the agent running this drain; its own recent commits do not block it.

Raw schema · ✎ Edit

Output

What a drain produces: the queue, one claim check per bean taken, and what each bean ended as. The three definitions are also the outputs of the drain-queue, bean-claim-check and open-work-lookup Tools. Skill work-plan/skills/work-plan/bean-drain.md, bean n7x7.

FieldTypeRequiredDescription
queueanyyes
checksarrayyesOne per bean a drainer tried to take, skips included.
resultsarrayyesWhat each claimed bean ended as.
stagingLinksanynoThe staging preview behind any request the drain puts to the owner (an asked-owner question, a PR left for review): one deep link per changed page, with the same page on main. Required whenever a preview exists; when it does not, say so in missing. Rule: cat-harness skills/authoring/content-lifecycle/feedback-deep-links.md.

results[]

FieldTypeRequiredDescription
beananyyes
outcome"completed" | "scrapped" | "asked-owner" | "returned-to-todo" | "blocked"yesasked-owner: an ask-the-person question is open and its link is in the bean.
prsarray<string (uri)>no
questionstring (uri)noasked-owner only: the chat message holding the full question.

Raw schema · ✎ Edit


folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev