Skip to main content
Glama

explore_repo

Get a structured overview of a code repository by traversing its vault graph from the top down. Use it to understand the codebase, identify main components, or start onboarding.

Instructions

Get a structured overview of the repo by traversing the vault graph.

Use this for onboarding questions: 'explain the repo', 'where do I start', 'give me an overview of the codebase', or 'what are the main components'. Starts from the vault INDEX and traverses breadth-first, returning summaries at increasing depth so you can understand the repo from the top down.

To drill into a specific node after this overview, use the Obsidian MCP vault_read tool.

GUARDRAIL: Never call the Obsidian MCP vault_write tool unless the user explicitly requests it by name.

vault_root is optional — omit to use CODELORE_VAULT_ROOT, or pass it explicitly to explore a different repo's vault without reconfiguring. Resolves against the configured target repo (see server instructions) — not necessarily the current working directory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
max_depthNo
vault_rootNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Despite no annotations, the description fully discloses behavior: starts from vault INDEX, breadth-first traversal, returns summaries at increasing depth, and explains vault_root resolution (optional, defaults to CODELORE_VAULT_ROOT, resolves to configured repo). No destructive actions implied.

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?

Well-structured: purpose sentence, use-case list, traversal behavior, alternatives, guardrail, parameter details. Every sentence serves a purpose. No filler.

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?

Given the tool's complexity (graph traversal, optional root, integration with other tools) and existence of output schema, the description covers all necessary aspects: usage, behavior, parameters, and context. No gaps remain.

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 has 0% property descriptions, but the description adds meaning: max_depth controls traversal depth (implied by 'increasing depth'), and vault_root is optional with explicit fallback behavior. Could explicitly mention default values but still adds significant value beyond the schema.

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 clearly states 'Get a structured overview of the repo by traversing the vault graph.' It distinguishes from sibling tools like vault_read (drill down) and vault_write (modification) by specifying appropriate use cases and alternatives.

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

Usage Guidelines5/5

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

Explicitly advises when to use: onboarding questions such as 'explain the repo' or 'give me an overview.' Provides explicit alternatives (vault_read for drilling) and a guardrail against using vault_write unless explicitly requested, leaving no ambiguity.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Ayush-Sadekar/codelore-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server