Skip to main content
Glama

dir

Read-only

List directory contents in column-aligned JSON format. Supports recursive depth, hidden files, symlink following, streaming, and result limiting.

Instructions

List directory contents in column-aligned format — alias for 'ls' producing structured JSON. Read-only, no side effects. Supports recursive depth, hidden files, symlink following, streaming (NDJSON), and result limiting. Returns per-entry metadata: type, size, permissions, modification time. Use for clean tabular directory listings. Prefer 'dir' over 'ls' when column-aligned output is desired; prefer 'ls' for default list format. Not for extended metadata — use 'vdir' for verbose output or 'stat' for single-file detail. See also 'ls', 'vdir', 'stat'.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoFile or directory to list..
limitNoMaximum entries to emit.
streamNoEmit NDJSON one entry per line for large directories.
max_depthNoMaximum recursive depth.
recursiveNoRecurse into directories.
include_hiddenNoInclude names starting with '.'.
follow_symlinksNoFollow symlinked directories.
Behavior4/5

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

Annotations already declare readOnlyHint=true, so description adds value by stating 'Read-only, no side effects' and mentioning streaming, result limiting, and output metadata. No contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with main purpose; additional details follow. Could be slightly more concise but remains informative and well-structured.

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?

Covers main features (recursive, hidden, symlinks, streaming, limit) and mentions returned metadata. No output schema, but description compensates adequately.

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 description coverage is 100%, so baseline is 3. Description mentions support for recursive depth, hidden files, etc., but does not add new parameter meaning beyond 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?

Directly states it lists directory contents in column-aligned format, and notes it is an alias for 'ls' producing structured JSON. Clearly differentiates from siblings like 'ls', 'vdir', 'stat'.

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 'dir' over 'ls', and when to use 'vdir' or 'stat' instead. Provides clear contextual guidance.

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/caseSHY/AI-CLI'

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