Skip to main content
Glama

get_project_tree

Obtain a structured tree view of the repository, respecting .gitignore rules, to navigate the codebase.

Instructions

Returns a structured tree view of the project repository, respecting .gitignore rules.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoSubdirectory to list (relative to project root). Defaults to root.
max_depthNoMaximum depth to traverse. Default: config value.
show_hiddenNoInclude hidden files/dirs (starting with dot). Default: false.
Behavior3/5

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

The description mentions that the tree view respects .gitignore rules, which is a behavioral detail. However, with no annotations provided, the description carries the full burden; it does not disclose result format, recursion behavior (though max_depth parameter suggests depth control), performance implications, or whether it includes file contents. Some transparency but not comprehensive.

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 a single sentence of 12 words, no redundant information. It front-loads the core purpose (returns a tree view) and appends the key rule (respects .gitignore). Every word earns its place.

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

Completeness3/5

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

Given the tool has 3 parameters, no output schema, and simple functionality, the description is somewhat complete but lacks explanation of the return format (e.g., JSON, list) or behavior with large directories. It covers the main constraint (.gitignore) but not other aspects like depth or hidden files (though parameters handle those). More detail would be helpful.

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

Parameters3/5

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

Schema coverage is 100%, so the input schema already describes each parameter (path, max_depth, show_hidden) with adequate descriptions. The tool description adds no additional meaning beyond what the schema provides, so baseline score of 3 is appropriate.

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 it returns a structured tree view of the project repository while respecting .gitignore rules. This differentiates it from sibling tools like get_changed_files (diffs), get_project_index (index), get_semantic_context (semantic), and search_codebase (search). The verb 'returns' and resource 'project repository' are specific.

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

Usage Guidelines3/5

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

The description implies the tool is for browsing the project's directory structure, but it does not explicitly state when to use it versus alternatives or provide any exclusions or prerequisites. No guidance on when not to use this tool.

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/Eltortilla1/synapse-code-mcp'

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