get_udp_connections

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

With no annotations, the description carries the burden of behavioral disclosure. It clearly indicates a read-only operation ('Get') and explains the namespace parameter's effect (query a specific namespace, default root). It does not mention potential errors, permissions, or limitations, but for a simple getter this is adequate and adds value beyond the schema.

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 concise: one sentence stating the purpose, followed by a clear Args section. It is front-loaded with the core action and avoids redundancy. Every element contributes to understanding.

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 one optional parameter, and the description adequately explains it. An output schema exists, so return-value details are not required in the description. The description is sufficient for correct invocation, though it does not mention edge cases like invalid namespace values or whether the operation requires special privileges.

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 explains the sole parameter 'namespace' beyond the schema, clarifying its purpose (network namespace to query) and default behavior (root namespace). The schema itself provides no descriptions (0% coverage), so the description fully compensates and adds meaningful context.

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 a specific action ('Get active UDP sockets') on a defined resource (the WLAN Pi). It is distinct from sibling tools like get_tcp_connections, making its purpose unambiguous.

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 implies usage when UDP socket information is needed, but it does not explicitly contrast with alternatives (e.g., get_tcp_connections) or provide conditions for when to choose this tool over others. No when-not-to-use guidance is given, so it relies on the agent to infer context.

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