pmg_who_group_get

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

Declares read-only, which is important. With no annotations, this conveys safety. Describes return type (dict of config) and prerequisite. Good coverage for a simple read operation.

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?

Three concise sentences, front-loaded with read-only flag and purpose. Every sentence adds distinct value. No redundancy.

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 a simple get tool with output schema, description covers purpose, parameter clarification, prerequisite, and relation to sibling tools. No gaps.

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 has full description coverage. Description adds value by clarifying ogroup is numeric ID from pmg_who_groups_list, not name. Proximo_target is adequately described in schema, no additional detail needed.

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?

Description clearly states this tool retrieves the configuration of a PMG RuleDB 'who' object group. It distinguishes from siblings by noting it returns config, not objects, and points to pmg_who_group_objects for listing objects.

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 prerequisite (PROXIMO_PMG_* config) and clarifies input (ogroup numeric ID from pmg_who_groups_list). Suggests alternative tool for objects, providing good context for when to use.

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