get_deep_directory_tree

Instructions

Implementation Reference

• src/index.ts:70-105 (registration)

  Registration of the 'get_deep_directory_tree' tool with the MCP server using mcp.tool(), specifying name, description, input schema, and handler function.

  mcp.tool(
    "get_deep_directory_tree",
    "Get deep directory tree",
    {
      path: z
        .string()
        .describe("Path to get the directory tree (preferably absolute path)"),
      options: z
        .object({
          depth: z.number().default(3).describe("Depth of the directory tree"),
          excludePatterns: z
            .array(z.string())
            .default(["node_modules", ".git", ".turbo", "dist", ".next"])
            .describe(
              "Patterns to exclude from the tree (e.g., ['node_modules', '*.log'])"
            ),
        })
        .default({
          depth: 3,
          excludePatterns: ["node_modules", ".git", ".turbo", "dist", ".next"],
        })
        .describe("Tree generation options"),
    },
    async ({ path, options }) => {
      const directoryStructure = getDirectoryTree(path, options);
  
      return {
        content: [
          {
            type: "text",
            text: directoryStructure,
          },
        ],
      };
    }
  );

• src/index.ts:73-92 (schema)

  Zod schema definition for the tool inputs: 'path' (string) and 'options' (object with depth and excludePatterns).

  {
    path: z
      .string()
      .describe("Path to get the directory tree (preferably absolute path)"),
    options: z
      .object({
        depth: z.number().default(3).describe("Depth of the directory tree"),
        excludePatterns: z
          .array(z.string())
          .default(["node_modules", ".git", ".turbo", "dist", ".next"])
          .describe(
            "Patterns to exclude from the tree (e.g., ['node_modules', '*.log'])"
          ),
      })
      .default({
        depth: 3,
        excludePatterns: ["node_modules", ".git", ".turbo", "dist", ".next"],
      })
      .describe("Tree generation options"),
  },

• src/index.ts:93-105 (handler)

  Async handler function that invokes getDirectoryTree with provided path and options, then returns the directory structure as text content in MCP format.

    async ({ path, options }) => {
      const directoryStructure = getDirectoryTree(path, options);
  
      return {
        content: [
          {
            type: "text",
            text: directoryStructure,
          },
        ],
      };
    }
  );

• src/index.ts:26-68 (helper)

  Core helper function getDirectoryTree that recursively traverses the directory up to specified depth, excludes patterns, and builds a tree string representation.

  function getDirectoryTree(
    rootPath: string,
    options: TreeOptions = {
      depth: 3,
      excludePatterns: ["node_modules", ".git", ".turbo", "dist", ".next"],
    }
  ) {
    const tree: string[] = [];
  
    function shouldExclude(file: string): boolean {
      return options.excludePatterns.some((pattern) => {
        if (pattern.includes("*")) {
          const regexPattern = pattern.replace(/\*/g, ".*");
          return new RegExp(regexPattern).test(file);
        }
        return file === pattern;
      });
    }
  
    function traverse(dir: string, currentDepth: number = 0) {
      if (currentDepth >= options.depth) return;
  
      const files = fs.readdirSync(dir);
      const filteredFiles = files.filter((file) => !shouldExclude(file));
  
      filteredFiles.forEach((file, index) => {
        const filePath = path.join(dir, file);
        const stats = fs.statSync(filePath);
        const isLast = index === filteredFiles.length - 1;
        const prefix = isLast ? "└── " : "├── ";
  
        if (stats.isDirectory()) {
          tree.push(`${"  ".repeat(currentDepth)}${prefix}${file}`);
          traverse(filePath, currentDepth + 1);
        } else {
          tree.push(`${"  ".repeat(currentDepth)}${prefix}${file}`);
        }
      });
    }
  
    traverse(rootPath);
    return tree.join("\n");
  }