read_resource

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

No annotations are provided, so the description carries the burden. It indicates a read operation, which is inherently non-destructive, but it does not mention behavior for missing resources, error handling, or side effects. For a simple read tool, this is adequate but not thorough.

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 a single concise sentence with no unnecessary words. It efficiently conveys the core purpose.

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 output schema is not provided, and the description does not mention the return format, possible errors, or how the resource is located relative to other tools. This leaves gaps in understanding what the agent will get back and how to handle edge cases.

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 provides only parameter names and types with no descriptions, and the description does not explain what project_dir and resource_name represent beyond the vague 'pipeline handoff state'. The meaning of these parameters is largely left to inference, making it difficult for an agent to know exactly what values to supply.

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 verb 'Read' and the object 'pipeline handoff state', which distinguishes it from write_resource. However, it could more explicitly differentiate from read_project_file, as both involve reading from the project directory.

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 phrase 'previously written piece' implies the tool is for reading resources created by write_resource, but it does not explicitly state when to prefer this over read_project_file or other sibling tools. More direct guidance would improve clarity.

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