pmg_when_group_get

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

With no annotations provided, the description carries the full burden. It states the operation is read-only and returns a dict of config, which is transparent enough for a simple read operation. It does not disclose additional behavioral details like side effects or rate limits, but none are expected.

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 three well-structured sentences. It states the purpose and requirement, describes the return value, and clarifies the parameter with a pointer to a related tool. No wasted 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 existence of an output schema, the description need not explain return values. It covers the tool's purpose, prerequisite, parameter clarification, and a related tool. It 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 the baseline is 3. The description reinforces that ogroup is a numeric ID from pmg_when_groups_list, which matches the schema description. It does not add significant new meaning beyond 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 it is a READ-ONLY operation to get the configuration of a PMG RuleDB 'when' object group. It specifies the resource and action, and distinguishes from sibling tools like pmg_when_group_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?

The description provides explicit guidance: it is read-only, requires PROXIMO_PMG_* config, and clarifies that the ogroup parameter must be a numeric ID from pmg_when_groups_list. It also directs to use pmg_when_group_objects for listing objects inside the group. However, it does not explicitly list when not to use this tool.

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