Skip to main content
Glama

openwisp_get_device_group

Get details for an OpenWISP device group by UUID or ID via REST API, enabling AI assistants to inspect group configuration and membership.

Instructions

[Category: Devices & Controller] Get details for a device group. (HTTP GET /api/v1/controller/group/{id}/)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesGroup UUID or ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.0.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses only the HTTP method (GET) and the path, saying nothing about authentication, permissions, error behavior, or what the returned group detail contains for a read against the controller API.

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?

Very compact and front-loaded with the category tag followed by the action and endpoint. Every element is short and purposeful, though the bracketed category prefix is metadata padding rather than task guidance.

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 simple single-parameter get there is little an agent needs, but with no output schema the description could say what the group detail includes. It is adequate but leaves a small gap on return content and the from_cert alternative.

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

Parameters3/5

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

Schema description coverage is 100% and the single 'id' parameter is already documented as 'Group UUID or ID'. The description adds no format or lookup semantics beyond the schema, so the baseline 3 applies.

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 ('Get') and resource ('details for a device group'), so the agent knows this is a single-item retrieve. However, it does nothing to differentiate itself from sibling lookups like openwisp_get_device_group_from_cert, which the agent must disambiguate on its own.

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?

There is no when-to-use instruction, no mention of prerequisites, and no reference to the alternative openwisp_get_device_group_from_cert sibling. The only usage signal is the appended HTTP endpoint, which implies a GET but not the conditions that select this tool.

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