diagnose_ntop_error

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

No annotations are provided, so the description carries the burden of disclosing behavior. It usefully reveals that the tool uses OpenAI if OPENAI_API_KEY is set and otherwise returns a local fallback diagnosis. However, it does not mention side effects, permission requirements, or the format of the diagnosis.

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 concise and well-structured: the first sentence states the purpose, the second explains the conditional behavior. Every sentence contributes value with no redundancy or irrelevant details.

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?

Given the presence of three parameters, no annotations, and no output schema, the description is incomplete. It lacks parameter semantics, usage context, and expected output details, making it difficult for an agent to invoke the tool correctly without additional information.

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 has 0% description coverage, and the tool description does not explain the 'goal', 'context', or 'errorText' parameters. While 'errorText' can be inferred from the tool name and description, the purpose of 'goal' and 'context' remains ambiguous, and the description fails to compensate for the lack of schema documentation.

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's purpose with a specific verb and resource: 'Diagnose an nTop error'. However, it does not explicitly differentiate from the sibling tool 'swarm_diagnose_ntop', which may similarly diagnose errors, so it is clear but not fully distinguishing.

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 no guidance on when to use this tool versus alternatives like 'swarm_diagnose_ntop' or 'run_terminal_command'. It only states the core action, with no mention of use cases, prerequisites, or exclusions.

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