Function list_directory

functions/function_calling/file.py:169–235

List contents of a workspace-relative directory.

(
    path: Annotated[str, ParamMeta(description="Workspace-relative directory path")]=".",
    *,
    recursive: Annotated[bool, ParamMeta(description="Traverse subdirectories")] = False,
    max_depth: Annotated[int, ParamMeta(description="Maximum depth when recursive=True")] = 3,
    include_hidden: Annotated[bool, ParamMeta(description="Include entries starting with '.'")] = False,
    limit: Annotated[int, ParamMeta(description="Maximum entries to return")] = 500,
    _context: Dict[str, Any] | None = None,
)

def list_directory(
    path: Annotated[str, ParamMeta(description="Workspace-relative directory path")]=".",
    *,
    recursive: Annotated[bool, ParamMeta(description="Traverse subdirectories")] = False,
    max_depth: Annotated[int, ParamMeta(description="Maximum depth when recursive=True")] = 3,
    include_hidden: Annotated[bool, ParamMeta(description="Include entries starting with '.'")] = False,
    limit: Annotated[int, ParamMeta(description="Maximum entries to return")] = 500,
    _context: Dict[str, Any] | None = None,
) -> Dict[str, Any]:
    """List contents of a workspace-relative directory."""

    ctx = FileToolContext(_context)
    target = ctx.resolve_under_workspace(path)
    if not target.exists():
        raise FileNotFoundError(f"Directory not found: {path}")
    if not target.is_dir():
        raise NotADirectoryError(f"Path is not a directory: {path}")

    if limit <= 0:
        raise ValueError("limit must be positive")
    if recursive and max_depth < 1:
        raise ValueError("max_depth must be >= 1 when recursive")

    entries: List[Dict[str, Any]] = []
    stack: List[tuple[Path, int]] = [(target, 0)]
    base_relative = ctx.to_workspace_relative(target) or "."

    while stack and len(entries) < limit:
        current, depth = stack.pop()
        try:
            children = sorted(current.iterdir(), key=lambda p: p.name.lower())
        except (FileNotFoundError, PermissionError):
            continue
        for child in children:
            rel = child.relative_to(target)
            if not include_hidden and _path_is_hidden(rel):
                continue
            stat_size = None
            modified = None
            try:
                stat = child.stat()
                modified = stat.st_mtime
                if child.is_file():
                    stat_size = stat.st_size
            except (FileNotFoundError, PermissionError, OSError):
                pass
            entry = {
                "name": child.name,
                "relative_path": rel.as_posix(),
                "absolute_path": str(child),
                "type": "directory" if child.is_dir() else "file",
                "size": stat_size,
                "modified_ts": modified,
                "depth": depth,
            }
            entries.append(entry)
            if len(entries) >= limit:
                break