Skip to main content
Glama

pmg_when_group_objects

List all objects in a specified PMG RuleDB 'when' object group using its numeric group ID. Retrieve the objects for a given group to inspect or manage rule conditions.

Instructions

List the objects in a PMG RuleDB 'when' object group (read). Needs PROXIMO_PMG_* config.

PMG 9.1 pmgsh-verified path: GET /config/ruledb/when/{ogroup}/objects. ogroup: numeric ID string (e.g. '2') from the matching pmg_*_groups_list — NOT the group name.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ogroupYes
proximo_targetNoWhich configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses the read-only nature, the API path (GET), and config requirements. However, it does not address error cases, permissions, or side effects. This is adequate but not comprehensive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise, with two short paragraphs: the first states purpose and prerequisites, the second provides the API path and parameter guidance. No unnecessary words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

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, return value details are unnecessary. The description covers the core function and parameter guidance but lacks mention of pagination or ordering. It is adequate but not fully comprehensive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 50% (ogroup lacks schema description, proximo_target has it). The tool description adds value by explaining ogroup is a numeric ID string from the groups list, not the group name, which compensates for the missing schema description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states 'List the objects in a PMG RuleDB 'when' object group (read)', specifying the verb (list), resource (objects in a when group), and read-only nature. This distinguishes it from sibling tools like pmg_when_group_get (gets group details) and pmg_when_object_add/delete (modify objects).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description notes that it needs PROXIMO_PMG_* config and explains that ogroup is a numeric ID from the groups list, not a name. While it provides prerequisites and parameter sourcing guidance, it does not explicitly state when to use this tool over alternatives like pmg_when_group_get or pmg_what_group_objects.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/john-broadway/proximo'

If you have feedback or need assistance with the MCP directory API, please join our Discord server