Skip to main content
Glama

List groups

proxmox_list_groups
Read-only

List Proxmox user groups with their members and comments, and filter results by name or other fields to review access settings in your cluster.

Instructions

List user groups with their members and comments.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "proxmox_list_groups"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldsNo
searchNoCase-insensitive substring filter on names, IDs, tags and similar fields

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.1

TDQS

B3.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered by structured data. The description contributes the return content (members and comments), which is modest but real added context; it says nothing about result size, pagination, or why idempotentHint is false for a read.

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?

A single front-loaded sentence with no filler; verb, resource, and payload are all stated up front. Nothing could be removed without losing information.

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?

For a zero-required-parameter read list, this is minimally adequate: it says what is returned. It lacks any note on scope (all groups vs. filtered), how `fields` narrows the output, or why the search filter matches tags for a group resource — gaps a caller would notice.

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

Parameters2/5

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

Schema coverage is 50%: the `search` parameter is documented in-schema, but the `fields` array has no description anywhere. The description does not mention either parameter, so it fails to compensate for the undocumented `fields` projection parameter.

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

Purpose4/5

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

States a specific verb and resource: "List user groups with their members and comments." The qualifier "user" does disambiguate somewhat from firewall/HA groups, but the description never explicitly contrasts with proxmox_list_firewall_groups or proxmox_list_ha_groups, which an agent could plausibly confuse given the shared "groups" name.

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

Usage Guidelines2/5

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

No when-to-use guidance and no exclusions. With siblings like proxmox_list_firewall_groups and proxmox_list_ha_groups in the catalog, a sentence such as "use this for user groups, not firewall or HA groups" would be the obvious value-add, and it is absent.

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

Deploy Server

Other Tools