Read workspace

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

Beyond the readOnly/idempotent annotations, the description discloses additional behavioral traits: node_modules and .git are excluded from listings, listings are sorted, and repeated calls match. This adds valuable context about output stability and hidden filters.

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

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

The description is two concise sentences, front-loaded with the primary action. Every clause adds information: listing, file content, exclusions, sorting. No fluff.

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

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

The presence of an output schema and annotations reduces the need for return-value or safety details. The description covers the two main use cases and relevant edge cases (exclusions, deterministic ordering). It leaves out error handling (e.g., missing file) but that is not critical given the schema and simplicity.

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

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

The schema already documents the 'path' parameter well ('Omit to list all files'). The description reinforces this but adds little about the 'workspaceId' parameter. With 50% schema coverage, the description could have compensated more for the undocumented workspaceId, but the context makes its purpose obvious.

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

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

The description uses specific verbs ('Lists', 'returns') and clearly identifies the resource (files in a workspace). It distinguishes between the two main behaviors (listing vs. file content) and, given sibling tools like write_files and destroy_workspace, the purpose is unambiguous.

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

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

The context is clear: use this to read or list workspace files. However, it does not explicitly state when not to use this tool or name alternatives. Since it is the only read-oriented tool among the siblings, the use case is implied rather than explicit.

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