read_file

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

With no annotations, the description carries the burden of behavioral disclosure. It adds useful constraints: the file must be UTF-8 text and access is restricted to the workflow workspace. However, it does not describe error handling, size limits, or return behavior (though an output schema exists). This is adequate but not rich.

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?

A single sentence that immediately states the action and key constraints. Every word earns its place.

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 simple read tool with one parameter and an output schema, the description covers the core behavior and the critical sandbox restriction. It is missing path semantics (relative vs absolute), but the low parameter count and existing output schema keep the gap moderate.

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 description coverage is 0%, so the description must compensate. It only identifies the parameter's referent as a UTF-8 text file in the workspace, without specifying path format, relative/absolute resolution, or defaults. This is minimal compensation for a single required parameter.

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 clearly states the action (read), the resource (UTF-8 text file), and the scope (sandboxed to the workflow workspace). This makes the tool's purpose unambiguous and distinct from siblings like write_file and list_dir.

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 when to use this tool—for reading UTF-8 text files within the workspace—but does not explicitly mention alternatives or exclusion cases (e.g., use json_get for structured JSON). This is implied usage, not explicit guidance.

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