shannon_read_workflow_log

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

With no annotations, the description carries the burden. It discloses that reading is tail-based by default and mentions parameters that affect this behavior (bytes, from_start). However, it does not specify behavior on missing workspaces, error handling, or output format.

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 conveys the core purpose and default behavior with no redundancy. Every word contributes meaning.

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 4 parameters and no output schema, the description covers the primary action and default behavior but omits details on workspaces_dir, return value structure, and error conditions. Adequate but not fully comprehensive.

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 50% (bytes and from_start have descriptions). The description adds value by explaining 'tail by default' which relates to from_start, but workspace and workspaces_dir remain undocumented. The implied meaning of workspace is clear, but workspaces_dir lacks explanation.

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?

Description clearly states 'Read workflow.log for a workspace' with a specific verb and resource, and adds the qualifier '(tail by default)' which distinguishes its default behavior from other read tools like shannon_read_report.

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?

No explicit guidance on when to use this tool versus siblings like shannon_read_report or shannon_status. The description implies log reading but doesn't clarify context or alternatives.

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