se_list

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

Discloses read-only nature, data source (serviceengine-inventory endpoint with merged config/runtime), and that the full list is returned in one call with no pagination. Annotations already signal safety; description adds valuable specifics.

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?

Two focused sentences: first gives purpose and output, second gives usage guidance and alternative. Every word serves a purpose.

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 zero parameters, comprehensive annotations, and an output schema, the description covers all necessary context: what it does, what it returns, when to use it, and how it differs from alternatives.

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?

No parameters exist; description correctly states 'no parameters required.' Schema coverage is 100%, so description adds no extra param semantics beyond confirming the absence.

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?

Description clearly states action: 'List all Service Engines' and specifies exact output fields. Distinguishes from sibling 'se_health' by contrasting use cases.

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?

Explicitly tells when to use (inventory capacity, find SE name/IP) and when not to (use se_health for per-SE status). Also notes no parameters and no pagination.

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