Skip to main content
Glama

list_directory

Lists files and directories at a specified path, with options to include hidden items and perform recursive searches.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
includeHiddenNo
recursiveNo

Implementation Reference

  • The handler function that executes the list_directory tool logic: validates the directory path, recursively lists files/directories using the helper function, and returns the formatted list as text content.
    async ({ path: dirPath, includeHidden, recursive }) => {
      return wrapToolExecution(async () => {
        const validatedPath = await validatePathExists(dirPath);
        const results: string[] = [];
    
        await listDirectoryRecursive(validatedPath, "", includeHidden, recursive, results);
    
        return {
          content: [{
            type: "text" as const,
            text: results.length > 0 ? results.join("\n") : "Directory is empty"
          }]
        };
      }, {
        errorCode: ERROR_CODES.FILE_OPERATION,
        context: "Failed to list directory"
      });
    }
  • Zod input schema defining parameters for the list_directory tool: path (required string), includeHidden (optional boolean), recursive (optional boolean).
    {
      path: z.string().min(1, "Path is required"),
      includeHidden: z.boolean().optional().default(DEFAULTS.INCLUDE_HIDDEN_FILES),
      recursive: z.boolean().optional().default(DEFAULTS.RECURSIVE_SEARCH)
    },
  • Registers the list_directory tool on the MCP server using server.tool(), including schema and handler.
    function registerListDirectory(server: McpServer): void {
      server.tool("list_directory",
        {
          path: z.string().min(1, "Path is required"),
          includeHidden: z.boolean().optional().default(DEFAULTS.INCLUDE_HIDDEN_FILES),
          recursive: z.boolean().optional().default(DEFAULTS.RECURSIVE_SEARCH)
        },
        async ({ path: dirPath, includeHidden, recursive }) => {
          return wrapToolExecution(async () => {
            const validatedPath = await validatePathExists(dirPath);
            const results: string[] = [];
    
            await listDirectoryRecursive(validatedPath, "", includeHidden, recursive, results);
    
            return {
              content: [{
                type: "text" as const,
                text: results.length > 0 ? results.join("\n") : "Directory is empty"
              }]
            };
          }, {
            errorCode: ERROR_CODES.FILE_OPERATION,
            context: "Failed to list directory"
          });
        }
      );
    }
  • Recursive helper function that traverses directories, filters hidden files if not included, and collects file/directory listings with prefixes.
    async function listDirectoryRecursive(
      currentPath: string,
      baseRelative: string,
      includeHidden: boolean,
      recursive: boolean,
      results: string[]
    ): Promise<void> {
      const entries = await readdir(currentPath, { withFileTypes: true });
    
      for (const entry of entries) {
        if (!includeHidden && entry.name.startsWith('.')) {
          continue;
        }
    
        const relativePath = path.join(baseRelative, entry.name);
        const fullPath = path.join(currentPath, entry.name);
    
        const prefix = entry.isDirectory() ? "[DIR]" : "[FILE]";
        results.push(`${prefix} ${relativePath}`);
    
        if (recursive && entry.isDirectory()) {
          await listDirectoryRecursive(fullPath, relativePath, includeHidden, recursive, results);
        }
      }
    }
  • src/index.ts:65-65 (registration)
    Calls registerFileTools which includes registration of list_directory among file tools.
    registerFileTools(server);
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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

Completeness1/5

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

Tool has no description.

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

Parameters1/5

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

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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

Usage Guidelines1/5

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

Tool has no description.

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/ishuru/open-mcp'

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