service_inspect

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

Annotations already state readOnly and non-destructive; description adds no new behavioral traits beyond returning attributes. Consistent but doesn't extend.

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 sentences front-loaded with purpose, then structured list of args and return type. Efficient and no wasted words.

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 read tool with annotations, description covers purpose, args, and return type adequately. No missing essential context.

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?

Provides brief descriptions for both parameters (id_or_name, insert_defaults) beyond schema types, clarifying their purpose despite schema coverage being 0%.

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?

Describes 'get a swarm service by id or name', specifying verb and resource clearly. Distinguishes from sibling tools like service_list or service_ps.

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?

Implies usage for inspecting a specific service, but no explicit when/when-not or alternatives compared to siblings like service_list for listing.

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