Skip to main content
Glama

scan_folder

Read-only

Lists the top-level files tidy would process in a folder so you can preview what will be renamed or sorted before cleanup.

Instructions

List the files tidy would look at in a folder (top level only, no hidden files).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "scan_folder"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
limitNo

Output Schema

NameRequiredDescriptionDefault
filesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • removedOutput schema / $defs / FileInfo / properties / path / format
      Removed value: -"path"
  2. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description does add genuine behavioral context beyond that: it enumerates top-level only and excludes hidden files, which materially affects what the agent sees. However, it says nothing about truncation, ordering, or what happens when the folder exceeds the default limit of 500.

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?

A single tight sentence with the scoping constraints front-loaded in a parenthetical, and no wasted wording. It is appropriately sized for a simple read tool, though the qualifiers would read better as a separate clause than an inline parenthetical.

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

Completeness3/5

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

An output schema exists, so return-value explanation is not required, and the annotations cover the safety profile. What is missing is material for a listing tool: the semantics of `limit` and the default-500 truncation behavior, which an agent needs in order to know whether a scan was complete.

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

Parameters2/5

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

Schema description coverage is 0%, so the description carries the full burden and largely fails it. It never explains what `path` is relative to (absolute, workspace-relative, sandboxed) and never mentions `limit` at all, leaving the agent unaware that results may be silently capped at 500.

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

Purpose4/5

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

The description names a specific verb and resource ("List the files") and scopes it to what "tidy would look at in a folder," which implicitly links it to plan_tidy/apply_plan. It clearly states the enumeration boundaries (top level only, no hidden files), so the agent knows exactly what set is returned, but it never names a sibling tool to contrast against.

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

Usage Guidelines3/5

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

Usage is only implied: because the output is what "tidy would look at," an agent can infer this is a read/preview step preceding plan_tidy. There is no explicit "use this when X, use plan_tidy when Y" routing, and no statement of prerequisites such as whether the path must exist or be accessible.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.