Skip to main content
Glama
N0moreher0
by N0moreher0

List files

project_list_files
Read-only

Lists files and directories in the workspace, showing a depth-limited tree in one call to inspect paths before reading. Use it to check directory structure or find files.

Instructions

List files/directories in the workspace. depth 1..3 shows the tree in a single call. Use when: you need to see the directory tree, check a path, or list files before reading. Avoid when: you only need one file's metadata (project_get_file_info) or one file's contents (project_read_file). Speed: fast; TTL cache 1.5s, auto-wiped on write/edit/delete. Output: file_list: entries, truncated, hint. Batch-safe: yes

Input Schema

NameRequiredDescriptionDefault
depthNo
limitNo
relative_pathNoPath inside the workspace (relative, or absolute inside the workspace)
include_ignoredNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.4/5.0
Behavior4/5

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

Annotations only declare readOnlyHint and openWorldHint, so the description adds real value beyond them: a 1.5s TTL cache that is auto-wiped on write/edit/delete, 'fast' speed, and 'batch-safe: yes'. It stops short of explaining truncation behavior beyond naming a 'truncated' field, and doesn't say what 'hint' contains.

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?

Front-loaded purpose, then labeled clauses (Use when / Avoid when / Speed / Output / Batch-safe) that an agent can scan in one pass. Zero filler sentences.

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?

No output schema exists, and the description compensates by naming the return keys (entries, truncated, hint) and summarizing caching and batching behavior. Still incomplete on limit/include_ignored semantics and pagination with a 200-entry cap, which matters for a list 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 only 25% (only relative_path has a schema description), so the description must compensate. It explains depth's 1..3 tree semantics, which is the most important behavior, but says nothing about limit, include_ignored, or what path resolution means beyond the schema string. Partial compensation for the coverage gap.

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?

States a specific verb and resource ('List files/directories in the workspace') and immediately contrasts itself with the sibling tools that do adjacent things (project_get_file_info, project_read_file). An agent can distinguish it from all 15 siblings without opening a schema.

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?

Explicit 'Use when' clause names three concrete situations (see tree, check a path, list before reading) and an 'Avoid when' clause routes to the two correct alternatives by name. This is the full when/when-not/alternative pattern.

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