Skip to main content
Glama

list_groups

Read-onlyIdempotent

Retrieve Nextcloud groups with optional search, limit, and offset, returning group IDs, display names, user counts, and pagination details for admin user management.

Instructions

List Nextcloud groups. Requires admin rights (or delegated user administration).

Nextcloud applies limit and offset to each group backend separately, so with more than one (LDAP and local groups, for example) a page can hold more than limit groups, and paging by offset can repeat or skip some.

Args: search: Optional text to filter groups by ID or display name. limit: Maximum number of groups to take from each group backend (1-200, default 50). offset: Number of groups to skip in each group backend (default 0).

Returns: JSON with "data" (list of groups with id, display_name, user_count, disabled_user_count) and "pagination" (count, offset, limit, has_more). The "id" is what update_user and the other group tools expect.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
offsetNo
searchNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.9.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so safety is covered. The description adds genuinely non-obvious behavior: admin/delegated-admin requirement and the per-backend pagination quirk where offset paging can repeat or skip groups.

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?

Front-loaded purpose followed by the caveat, then Args and Returns sections. The pagination paragraph is longer than strictly necessary but each sentence conveys a real constraint, so little is wasted.

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

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, yet the description still summarizes the return shape (per-group id, display_name, counts; pagination has_more) which is a bonus, not a redundancy. Auth, paging behavior, params, and return contract are all present for a read-only tool.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must carry the load, and it does: search filters by ID or display name, limit is capped at 1-200 with default 50 per backend, offset default 0. Range, default, and semantics are all supplied.

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?

Opens with a specific verb and resource ('List Nextcloud groups'), immediately distinguishing it from siblings like list_group_members, create_group, and delete_group. The added note that returned ids feed 'update_user and the other group tools' further clarifies scope.

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?

States the access prerequisite ('Requires admin rights (or delegated user administration)') and documents the limit/offset contract, but does not explicitly contrast this tool with alternatives such as list_users or list_group_members. Clear context, weaker on exclusions.

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