Skip to main content
Glama

Onboard this vault

onboard

Index 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

NameRequiredDescriptionDefault
actionYes"start" returns the onboarding playbook, "complete" marks the vault onboarded (requires `summary`), "status" reports onboarded state and concept counts.
summaryNoRequired with "complete": 2–5 sentences on what was indexed and any notable gaps — stored as the product-onboarding-summary concept.
areaListNoWith "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.
repoHintNoWith "start": where the codebase lives (path or URL), echoed into the playbook.
productNameNoWith "start": the product's name, echoed into the playbook heading.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description discloses behavior beyond the annotations: complete is conditionally rejected, the summary is stored as a concept, and incomplete onboarding causes a note to appear in search_concepts and get_context results. It also explains why areaList must come from the caller because Brainz cannot read the repo.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose and then devotes one dense, purposeful sentence to each action. There is no filler, and the most important workflow effects are placed early.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a stateful onboarding workflow with no output schema, it explains what each action returns or stores, the rejection condition for completion, and cross-tool side effects. An agent has enough context to choose an action and call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, so this is judged on added meaning. The description reinforces conditional parameter combinations, such as areaList being supplied for status and complete and summary being required for complete, and explains the consequence of uncovered areas.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'Index an existing product's codebase into this vault.' It then characterizes the three actions and how onboarding relates to upsert_concept, making the tool's scope clear without needing sibling comparison.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives precise per-action usage: start returns the playbook, status reports coverage, and complete stores the summary and is rejected when too many areas are uncovered. It does not explicitly compare against alternatives like sync or upsert_concept, but the action-level routing is very clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources