Skip to main content
Glama

read_project_structure

Retrieve the project's directory structure as a tree (excluding common build and dependency folders) to understand layout and identify services, packages, and entry points.

Instructions

Get the directory structure of the project. Returns a tree of files and directories, useful for understanding project layout during onboarding.

Excludes: node_modules, .git, dist, build, .grafema, coverage, .next, .nuxt

Use this tool when studying a new project to identify services, packages, and entry points.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoSubdirectory to scan (relative to project root). Default: project root.
depthNoMaximum directory depth (default: 3, max: 5)
include_filesNoInclude files in output, not just directories (default: true)
Behavior3/5

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

No annotations provided, so description carries full burden. Describes returns (tree), lists exclusions, but does not detail performance, permissions, or edge cases. Adequate but not rich.

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?

Very concise, front-loaded with purpose, no redundant sentences. Every sentence adds value. Length is appropriate for the complexity.

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

Completeness4/5

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

Given simple tool with 3 optional params and no output schema, description covers purpose, usage, and exclusions. Lacks info on output format or errors but is sufficient for a read-only tree tool.

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% with descriptions for all three parameters. Description adds minimal extra meaning beyond schema (e.g., default values repeated). Baseline score appropriate.

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

Purpose4/5

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

Clearly states it gets the directory structure and returns a tree of files/directories. Provides context for use (studying a new project) but does not explicitly differentiate from siblings, though the usage hint helps.

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?

Explicitly says when to use (when studying a new project) and lists excluded directories. Lacks explicit when-not-to-use notes, but the guidance is clear and actionable.

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/Disentinel/grafema'

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