node_list

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

Annotations already declare the tool as read-only and non-destructive. The description adds useful behavioral context by specifying that the tool can filter by attributes (id, name, membership, role) and returns a list of node attribute dictionaries. This goes beyond the annotations, but does not cover potential limits or error conditions.

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 extremely concise, consisting of a one-line purpose followed by a one-line documentation of parameters and return value. Every sentence serves a purpose, and there is no unnecessary text. It is well-structured with clear labels.

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 list tool, the description covers the main aspects: what it does, how to filter, and what it returns. With annotations covering safety, and no output schema, the description provides adequate context. However, it does not mention prerequisites (e.g., being in swarm mode) or any limitations, which could be helpful.

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 provides only the parameter name 'filters' with type object and no description. The description adds significant value by listing example filter attributes: id, name, membership, role. This helps the agent understand what values to use, compensating for the 0% schema coverage. However, the exact structure of the filter object is not fully specified.

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 action 'List' and the resource 'swarm nodes'. It distinguishes from sibling tools like node_inspect (which inspects a single node) and other list tools for different resources. The purpose is unambiguous and specific.

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 does not provide explicit guidance on when to use this tool versus alternatives like node_inspect or other listing tools. While the name and description imply its use for listing nodes, no exclusions or contextual cues are given. A better description would mention that it returns all nodes or when to use filters.

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