inspect_config

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

Without annotations, the description bears full burden. It does not disclose whether the tool is read-only, what side effects occur (e.g., locking, caching), or authentication needs. 'Parse and summarize' implies reading but no explicit confirmation.

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 sentence that front-loads the verb and resource, making it efficient. However, it sacrifices necessary detail for brevity, which slightly limits its effectiveness.

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?

Despite having an output schema, the description omits behavioral characteristics like error handling, output format summary, or differences in parsing across file types. The tool's simplicity (1 param) reduces the gap, but the description remains insufficient for confident invocation.

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%, and the description adds no meaning beyond the schema. It does not explain the path parameter's expected format, location, or constraints (e.g., relative vs absolute). The supported file types are listed but not tied to the 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 tool parses config files and lists supported formats (YAML/JSON/.env/Prisma/TOML/text), which distinguishes it from sibling tools like inspect_schema. However, 'summarize' is somewhat vague, and the tool's exact scope could be more precise.

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 guidance is provided on when to use this tool versus alternatives like inspect_schema or generate_rollback. The description lacks context about appropriate scenarios or prerequisites (e.g., file must exist, must be readable).

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