get_flow_by_name

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

Annotations already declare readOnlyHint=true and idempotentHint=true, which indicate safe, idempotent behavior. The description adds no behavioral trait beyond 'fairly frequent', which is a usage frequency note. This does not contradict annotations but adds minimal value.

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 with a parenthetical, making it very concise. It is front-loaded with the core function. The parenthetical is slightly informal but not detrimental.

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?

For a simple lookup tool with one parameter and safety annotations, the description is minimally adequate. However, it does not describe what the return value is (a flow object), which would be helpful given no output schema. It is sufficient but could be more informative.

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 input schema has one parameter 'flow_name' with description 'Flow name to look up', achieving 100% schema coverage. The description adds no additional information about the parameter, so it meets the baseline but does not enhance understanding.

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 flow by name (fairly frequent)' clearly states the action (get) and resource (flow by name). However, it does not differentiate from sibling tools like get_all_flows or get_flows_for_file, which retrieve flow data in different ways.

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. The parenthetical 'fairly frequent' implies common usage but offers no context, exclusions, or conditions for its use.

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