get-bot-by-name

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

No annotations exist, so the description must disclose behavior. It does not mention whether the bot is returned with all data, whether include parameter affects deletion status, or any other behavioral traits. It is completely opaque.

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, which is concise but too terse to be informative. It would benefit from a brief second sentence about return value or scope.

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 low complexity (3 params, no output schema), the description provides insufficient context. It omits what the tool returns, how 'fields' and 'include' work, and any prerequisite conditions. For a retrieval tool, the agent needs more to use it correctly.

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% but the description adds no additional meaning. The 'name' parameter is just 'Bot name', 'fields' is 'Comma-separated fields to include' (no list of available fields), and 'include' has an enum but no description. The description fails to compensate for the missing schema description of 'include'.

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 'Get bot by name' is essentially a tautology of the tool name. It does not clarify what a 'bot' is in this context or distinguish this tool from siblings like get-bot or list-bots.

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 on when to use this tool versus alternatives. There are many sibling get tools (e.g., get-bot, get-chart-by-name) but no differentiation criteria are provided.

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