get-bot

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

No annotations are provided, so the description carries full burden. It only states 'Get bot details', which implies a safe read, but lacks details on error behavior, effects of the 'include' and 'fields' parameters, or any mutation side effects. The description is insufficiently transparent.

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 very short (6 words) and front-loaded, but it sacrifices helpful detail. Conciseness is achieved, but the single sentence is not structured to convey necessary context for correct invocation.

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 no output schema, no annotations, and a moderate number of parameters (3), the description is incomplete. It fails to explain the meaning of 'fields' and 'include', the output format, or how to choose between this and the sibling get-bot-by-name 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 coverage is 67%: id and include have descriptions, but fields has none. The description adds no value beyond the schema; it does not elaborate on what 'fields' or 'include' control. For a tool with 3 parameters, the description should clarify the optional parameters.

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 'Get' and the resource 'bot details' with the identifier type 'by UUID'. This distinguishes it from sibling get-bot-by-name, though it does not explicitly contrast with that tool.

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 vs alternatives like get-bot-by-name. The agent must infer from the parameter 'id' being a UUID. No when-not-to-use or precondition are mentioned.

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