pmg_ruledb_rule_from_list

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

Explicitly states it is a 'read' operation, indicating no destructive behavior. Provides the API path and clarifies id_ is a positive integer string. Does not discuss rate limits or response format, but given the read nature, transparency is good.

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?

Highly concise: one line for purpose, one for config, one for API path, and one for parameter. No fluff, front-loaded with purpose.

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, return values need not be detailed. Description covers purpose, config requirement, and parameter. Could mention that it lists multiple objects, but overall complete for a read-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?

Adds meaning to id_ beyond schema by specifying 'positive integer string' with an example. The proximo_target parameter is already described in the schema; description reinforces it. Schema coverage is 50%, but description compensates for 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?

Specifically states it lists 'from' objects attached to a PMG RuleDB rule (read). Differentiates from sibling tools like pmg_ruledb_rule_from_attach/detach via the 'read' designation. Also provides the API path.

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?

Mentions 'Needs PROXIMO_PMG_* config' as a prerequisite but does not explicitly state when to use this tool over siblings (e.g., pmg_ruledb_rule_to_list, pmg_ruledb_rule_what_list). Usage is implied by name and description.

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