pmg_ruledb_rule_when_list

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

With no annotations provided, the description carries the full burden. It explicitly labels the operation as '(read)', implying no destructive effects, and mentions required configuration. However, it does not disclose error handling or behavior for missing rule IDs.

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 at two short paragraphs, front-loading the purpose and including only essential details. No superfluous information.

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 does not need to explain return values. It covers the core functionality, prerequisites, API path, and parameter specifics. Minor omission: no mention of pagination or limits, but acceptable for a list 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 meaningful information for the required parameter id_ (type, constraint 'positive integer string', example '100'), which is only listed as 'string' in the schema. The optional parameter proximo_target is already well-described in the schema.

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 'List', the resource ''when' objects attached to a PMG RuleDB rule', and the read-only nature. It differentiates from siblings like pmg_ruledb_rule_when_attach and pmg_ruledb_rule_when_detach via its name and contextual context.

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 specifies a prerequisite ('Needs PROXIMO_PMG_* config') and provides the API path. While it does not explicitly state when not to use or offer alternatives, the context with sibling tools makes the usage clear.

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