pbs_metrics_influxdb_udp_get

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

With no annotations, the description carries full burden. It explicitly states 'READ-ONLY' (no modifications), notes absence of secrets ('No secret field exists'), and required config. These go beyond basic function naming, though side effects or error handling are not covered. For a simple get, this is adequate.

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 with two sentences and a reference to a module docstring fact. It front-loads the purpose and key behavioral notes. The docstring reference (#2) is somewhat cryptic but does not detract significantly. No unnecessary 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?

Given the presence of an output schema, the description covers the essential: purpose, read-only nature, security note, and config prerequisite. It does not detail error scenarios, but for a simple get operation, this is complete enough for an agent to use correctly.

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?

Schema coverage is 100%, so baseline is 3. The description adds no extra meaning to parameters beyond what the schema already provides (name and proximo_target are well-documented in the schema). No additional parameter context is given.

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 verb 'get' and the resource 'one PBS InfluxDB udp metric server's config.' It distinguishes from sibling list tools by implying this retrieves a single config by name, while list retrieves all.

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 labels the tool as 'READ-ONLY' and notes the need for 'PROXIMO_PBS_* config.' It implies usage for retrieving a specific server's config, but does not explicitly compare to siblings or state when not to use. The context from siblings (list, create, etc.) provides implicit guidance.

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