Skip to main content
Glama

pmg_when_group_create

Create a RuleDB 'when' group in PMG. Dry-run by default; set confirm=True to execute. Define name, optional description, AND/OR logic, and inversion.

Instructions

MUTATION (LOW): create a PMG RuleDB 'when' object group. Dry-run by default. confirm=True to execute. Needs PROXIMO_PMG_* config. PMG 9.1 pmgsh-verified path: POST /config/ruledb/when. name: group name. info: optional description. and_: maps to API param 'and' (bool; AND vs OR logic for group members). invert: if True, the group match is inverted. Returns the numeric ogroup ID assigned by PMG on confirm.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
and_No
infoNo
nameYes
invertNo
confirmNo
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, the description carries the full burden. It discloses mutation severity, dry-run behavior, API path, return value, and dependency on PROXIMO_PMG_* config. It does not mention error handling or reversibility, but covers major behavioral aspects.

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

Conciseness4/5

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

The description is a single concise paragraph, front-loaded with key info (MUTATION, dry-run, API path). It efficiently lists parameters and their roles without unnecessary words.

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 tool's moderate complexity and presence of an output schema, the description covers purpose, parameters, usage, auth, and output. It could add context about relationships to other PMG objects, but is largely complete for a creation tool.

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 low (17%), but the description adds meaning for most parameters: explains 'and_' maps to API 'and', 'confirm' for dry-run, and 'invert' semantics. It omits 'proximo_target', but overall enhances understanding beyond 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 verb ('create'), the resource ('PMG RuleDB 'when' object group'), and distinguishes from sibling tools like pmg_when_group_delete or pmg_when_group_get. It also provides the API path, making the purpose unambiguous.

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 mentions the dry-run default and the need for 'confirm=True' to execute, plus the configuration requirement. It does not explicitly compare to alternative tools or specify when not to use, but the context is clear for a creation operation.

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