portainer_networks_list

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

No annotations are provided, so the description must carry full burden. It indicates a read operation ('list') and mentions default endpoint behavior, but omits details on permissions, page limits, sorting, or whether the list includes all networks or only those visible to the endpoint.

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 two sentences with no redundant words, achieving high conciseness. It could be improved by structuring the parameter explanation more clearly, but the current layout is functional.

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?

With an output schema present, the return format is covered externally. However, the description lacks context on when to use this tool among many sibling tools, and does not explain the scope of 'list' (e.g., all networks or filtered). It is minimally complete for a simple listing tool.

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 description adds meaning to the single parameter 'endpoint_id' by stating it is a target endpoint and defaults when omitted. Given 0% schema coverage, this is valuable, but it could elaborate on what constitutes a valid endpoint ID or how to find it.

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 ('Docker networks on an endpoint'), distinguishing it from sibling tools like portainer_network_create or portainer_network_inspect. However, it does not explicitly differentiate from other list tools (e.g., portainer_containers_list), though the resource type is distinct.

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 like portainer_network_inspect or portainer_networks_list. It does not mention prerequisites, filtering, or scenarios where listing is appropriate.

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