Skip to main content
Glama

pmg_when_group_objects

Fetch all member objects of a PMG 'when' group by numeric ID. Returns a list of object dictionaries for rule inspection.

Instructions

READ-ONLY: list the objects in a PMG RuleDB 'when' object group. Needs PROXIMO_PMG_* config.

Returns a list of object dicts. ogroup: numeric ID (e.g. '2') from pmg_when_groups_list — NOT the group name. Use pmg_when_group_get for the group's own config (not its member objects).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ogroupYes'when' object group numeric ID (e.g. '2') from pmg_when_groups_list — not the group name.
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
Behavior4/5

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

With no annotations provided, the description carries the full burden. It declares READ-ONLY, indicating no side effects, and states it returns a list of object dicts. This adequately discloses behavior for a read-only list tool, though it does not detail the structure of returned objects (but output schema exists).

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 extremely concise: three terse sentences covering purpose, read-only status, config requirement, return type, and parameter clarification. No extraneous words, and key information is front-loaded.

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

Completeness4/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, the description does not need to detail return values. It covers the essential purpose, usage distinction, and parameter hint. It is complete enough for an agent to understand when and how to use this tool, though it could mention that the result is a list of object definitions.

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 coverage is 100%, but the description adds value by clarifying that 'ogroup' is a numeric ID from pmg_when_groups_list and not a group name, which reduces ambiguity. The second 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.

Purpose5/5

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

The description clearly states the tool lists the objects in a PMG RuleDB 'when' object group, and explicitly distinguishes it from pmg_when_group_get by noting that the latter retrieves the group's own configuration. The verb 'list' and resource specification are precise.

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

Usage Guidelines4/5

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

The description indicates when to use this tool (to list member objects of a 'when' group) and provides an alternative (pmg_when_group_get for group config). It also notes the requirement for PROXIMO_PMG_* config. However, it does not explicitly state when not to use this tool (e.g., if you need group properties).

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