read_config_snippet

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

No annotations are provided, so the description carries full burden. It discloses the two operational modes, the safety constraint of never reading the whole file, and a hard cap on max_lines. It could be improved by detailing error handling for missing files or permissions, but overall it is transparent about core behavior.

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 extremely concise at two sentences, with no wasted words. All information is relevant and front-loaded. It efficiently conveys the tool's purpose and usage modes.

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?

With an output schema present, return value explanation is not needed. The description covers the two use cases and constraints (never whole file, max_lines). It could mention that filepath is required and potential error conditions, but overall it is fairly complete for a read tool.

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 description must compensate. It explains the two modes (grep_pattern vs line range), and implicitly that context lines are used with grep_pattern. It also mentions max_lines as a hard cap. However, it does not explicitly describe each parameter's meaning beyond the modes, leaving some interpretation.

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 tool reads a slice of a text/config file, with two explicit modes: using grep_pattern or line range. It explicitly warns against reading the whole file, distinguishing it from a full file read.

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 provides clear guidance on when to use each mode (grep_pattern vs start/end_line) and mentions a hard cap on max_lines. However, it does not explicitly mention alternatives or when not to use this tool compared to siblings like grep_file or list_directory_tree.

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