Read workspace file

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

Annotations already declare readOnlyHint=true and openWorldHint=false, covering the safety and closed-world aspects. The description adds that it reads only UTF-8 text files, which is useful context not in annotations, but does not disclose error behavior, encoding constraints, or path resolution rules.

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?

One short sentence, front-loaded with verb and resource. No waste, but minimal detail.

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?

For a read tool with one undocumented parameter and no output schema explanation, the description is too sparse. It omits return format details (though output schema exists), error handling, and path constraints, leaving key gaps.

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?

Schema coverage is 0% and the single path parameter is entirely undocumented in both schema and description. The description does not explain path syntax, relative vs absolute, or whether it must be within the workspace. It fails to compensate for the coverage gap.

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?

States a specific verb (read) and resource (UTF-8 text file inside workspace), which distinguishes it from the sibling write_file and apply_patch tools. It does not explicitly name alternatives, but the scope contrast is clear.

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 description implies usage for reading text files in the workspace, but does not state when to use this vs list_directory or what happens for binary files. No explicit when-not or alternative routing.

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