portainer_network_inspect

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

No annotations are provided, so the description bears full responsibility for behavioral disclosure. It states that the tool retrieves information but does not indicate whether it is read-only, what permissions are needed, or that no side effects occur.

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 short and uses a structured 'Args:' block. It is not verbose, but it could be more concise by removing the redundant 'Args:' header when not needed.

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?

The tool has an output schema, so description need not explain returns. However, it does not clarify what 'detailed information' entails, nor the relationship to the endpoint. For a simple inspect tool, it is minimally adequate.

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?

With 0% schema description coverage, the description adds some meaning: network_id is defined as 'Network ID or name', and endpoint_id as 'Target endpoint ID (uses default if omitted)'. This goes beyond the raw schema but still lacks depth (e.g., how to find endpoint_id).

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 'Get detailed information about a Docker network,' which is a specific verb+resource. Among sibling tools, network_inspect is distinct from network_connect, create, disconnect, remove, and list.

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?

No explicit guidance on when to use this tool versus alternatives like portainer_networks_list (which lists networks) or other inspect tools. The description does not mention prerequisites, use cases, or when not to use it.

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