Skip to content

feat(filesystem): add maxDepth parameter to directory_tree #4023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
factspark23-hash wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −6
Open

feat(filesystem): add maxDepth parameter to directory_tree #4023

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions src/filesystem/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@ const ListDirectoryWithSizesArgsSchema = z.object({

const DirectoryTreeArgsSchema = z.object({
path: z.string(),
excludePatterns: z.array(z.string()).optional().default([])
excludePatterns: z.array(z.string()).optional().default([]),
maxDepth: z.number().int().min(0).optional().describe('Maximum depth to traverse. 0 = only the root directory, 1 = root + immediate children, etc. Omit for unlimited depth.')
});

const MoveFileArgsSchema = z.object({
Expand Down Expand Up @@ -532,6 +533,7 @@ server.registerTool(
"Get a recursive tree view of files and directories as a JSON structure. " +
"Each entry includes 'name', 'type' (file/directory), and 'children' for directories. " +
"Files have no children array, while directories always have a children array (which may be empty). " +
"Use 'maxDepth' to limit traversal depth (0 = root only, 1 = root + immediate children, etc.). " +
"The output is formatted with 2-space indentation for readability. Only works within allowed directories.",
inputSchema: {
path: z.string(),
Expand All @@ -548,7 +550,7 @@ server.registerTool(
}
const rootPath = args.path;

async function buildTree(currentPath: string, excludePatterns: string[] = []): Promise<TreeEntry[]> {
async function buildTree(currentPath: string, excludePatterns: string[] = [], currentDepth: number = 0): Promise<TreeEntry[]> {
const validPath = await validatePath(currentPath);
const entries = await fs.readdir(validPath, { withFileTypes: true });
const result: TreeEntry[] = [];
Expand All @@ -559,8 +561,6 @@ server.registerTool(
if (pattern.includes('*')) {
return minimatch(relativePath, pattern, { dot: true });
}
// For files: match exact name or as part of path
// For directories: match as directory path
return minimatch(relativePath, pattern, { dot: true }) ||
minimatch(relativePath, `**/${pattern}`, { dot: true }) ||
minimatch(relativePath, `**/${pattern}/**`, { dot: true });
Expand All @@ -574,8 +574,12 @@ server.registerTool(
};

if (entry.isDirectory()) {
const subPath = path.join(currentPath, entry.name);
entryData.children = await buildTree(subPath, excludePatterns);
if (args.maxDepth === undefined || currentDepth < args.maxDepth) {
const subPath = path.join(currentPath, entry.name);
entryData.children = await buildTree(subPath, excludePatterns, currentDepth + 1);
} else {
entryData.children = [];
}
}

result.push(entryData);
Expand Down
Loading