Skip to main content
Returns a brain’s containers: its table of contents, as a flat list where each container is labeled with its Path (its position in the hierarchy). Use this to understand how a brain is organized before searching it with query_brain or reading specific nodes.

Input

ParameterTypeRequiredDescription
brainIdstringYesThe brain to outline. Get it from list_public_brains.

Example

Prompt:
“Show me how the Supabase brain is organized.”
Tool call:
{
  "brainId": "fa8d5392-fc77-4eb4-8a4c-64e0005c56b6"
}
Response:
5 containers in brain fa8d5392-fc77-4eb4-8a4c-64e0005c56b6:

- Name: supabase.com/docs/guides
- ID: d54d8b31-...
- Description: Container for supabase.com/docs/guides/* routes
----------
- Name: supabase.com/docs/guides/auth
- ID: 7c3c2a4a-...
- Path: supabase.com/docs/guides
- Description: Container for supabase.com/docs/guides/auth/* routes
----------
- Name: supabase.com/docs/guides/database
- ID: 69607408-...
- Path: supabase.com/docs/guides
- Description: Container for supabase.com/docs/guides/database/* routes
----------
- Name: supabase.com/docs/reference
- ID: c577f7e7-...
- Description: Container for supabase.com/docs/reference/* routes
----------
- Name: supabase.com/docs/reference/javascript
- ID: 5c983119-...
- Path: supabase.com/docs/reference
Each container shows its Name, ID, and Path (its position in the hierarchy). Top-level containers have no Path.

When to use it

  • You want a map of the brain before deciding what to search for.
  • The agent should scope its reasoning to a known section of the docs.
  • You are exploring an unfamiliar brain and want its shape at a glance.

See also