flutter_source_read

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

No annotations are provided, so the description carries the full burden. It discloses the return format (numbered source), pagination limit (500 lines max per call), and behavior for empty/directory/file paths. This is solid behavioral disclosure for a read-only file accessor.

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?

Two sentences, front-loaded with the core purpose, and zero wasted words. The path-behavior rules are compactly packed into one sentence. Every clause 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 read-only source-access tool with 0 required params and no output schema, the description covers behavior for all three usage modes (overview, directory, file), pagination, and relative path semantics. It doesn't describe error cases or return types in detail, but for this simple tool class the description is nearly complete.

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 100%, so the baseline is 3. The description adds meaning to 'path' (relative to source root, omit for overview) and implies start_line/end_line usage through the numbering and pagination mention. It also explains the interaction between path and the line-range parameters. This adds some value but the schema already documents all parameters reasonably.

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), resource (vendored flutter_reactive_ble federation source), and scope (file/directory/overview). It distinguishes itself from siblings like flutter_source_search (searching) and flutter_docs/dart_docs (documentation lookup) by being specifically about reading vendored source files.

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 gives clear usage context: no path returns package tree/version manifest, a directory path lists it, and a file path returns numbered source. It also mentions pagination (500 lines max per call). It doesn't explicitly name alternative tools or state when NOT to use it, but the behavioral rules are well-covered and clear.

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