Onboard this vault
onboardIndex an existing product's codebase into this vault. {action: "start"} returns the onboarding playbook: a method for surveying the codebase and recording its product knowledge (domains, features, stories, specs, workflows, decisions, constraints) as concepts via upsert_concept, each anchored to the code with codeAreas. {action: "status", areaList} reports onboarded state, concept counts and, given your repo's source areas (Brainz can't read the repo), which areas are covered or uncovered. {action: "complete", summary, areaList} marks the vault onboarded and stores the summary; it is rejected while too many areas are uncovered. Until onboarding completes, search_concepts and get_context results include a one-line note saying so.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | "start" returns the onboarding playbook, "complete" marks the vault onboarded (requires `summary`), "status" reports onboarded state and concept counts. | |
| summary | No | Required with "complete": 2–5 sentences on what was indexed and any notable gaps — stored as the product-onboarding-summary concept. | |
| areaList | No | With "status" or "complete": the repo's top-level source areas (packages/*, apps/*/src subtrees, major dirs) from your own repo walk — Brainz can't read the repo. "status" diffs concepts' code_areas against this to report covered vs uncovered areas; "complete" is REJECTED if too many areas are still uncovered. | |
| repoHint | No | With "start": where the codebase lives (path or URL), echoed into the playbook. | |
| productName | No | With "start": the product's name, echoed into the playbook heading. |