Skip to main content
Glama

list_group_iterations

Read-only

List GitLab group iterations with filters for state, search, update date, and ancestor/descendant inclusion. Use this read-only tool to retrieve paginated iteration collections.

Instructions

List group iterations with filtering options. Use this for a collection of resources; choose the corresponding get tool when you already know the single resource to inspect. It is read-only and does not mutate GitLab data; missing resources, invalid identifiers, insufficient permission, and rate limits are returned as errors. When project_id or group_id is accepted, provide the numeric ID or complete URL-encoded path described by the schema; use required identifiers and pagination fields exactly as documented.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination (default: 1)
stateNoReturn opened, upcoming, current, closed, or all iterations.
searchNoReturn only iterations with a title matching the provided string.
group_idYesGroup ID or URL-encoded path
jmespathNoOptional JMESPath expression filtering the JSON result before return.
per_pageNoNumber of items per page (max: 100, default: 20)
search_inNoFields in which fuzzy search should be performed with the query given in the argument search. The available options are title and cadence_title. Default is [title].
updated_afterNoReturn only iterations updated after the given datetime. Expected in ISO 8601 format (2019-03-15T08:00:00Z).
updated_beforeNoReturn only iterations updated before the given datetime. Expected in ISO 8601 format (2019-03-15T08:00:00Z).
include_ancestorsNoInclude iterations for group and its ancestors. Defaults to true.
include_descendantsNoInclude iterations for group and its descendants. Defaults to false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.66
    • addedInput schema / properties / jmespath
      Added value: +{
      +  "description": "Optional JMESPath expression filtering the JSON result before return.",
      +  "type": "string"
      +}
  2. Addedv2.1.18
  3. Removedv2.1.14
  4. Addedv2.1.11
  5. Removedv2.1.10
  6. Changed2 schema fields changedv2.1.9
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / required
      Added value: +[
      +  "group_id"
      +]
  7. First observedv1.0.0

TDQS

A4.1/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true, and the description reinforces non-mutation while adding useful behavioral detail about errors for missing resources, invalid identifiers, insufficient permission, and rate limits. This goes beyond the annotations without contradicting them.

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 front-loaded with the main action first, and most sentences carry real guidance: collection scope, read-only/error behavior, and identifier handling. The only minor redundancy is stating both 'read-only' and 'does not mutate,' but it does not bloat the description significantly.

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?

For a filtered list tool with rich schema descriptions and readOnlyHint/openWorldHint annotations, the description provides adequate context: scope, error behavior, pagination handling, and identifier guidance are covered. Without an output schema, it does not describe the return shape, but the core invocation context is sufficiently complete.

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 schema coverage is 100%, so the schema already documents all parameters in detail. The description adds a general identifier-format guideline, but no additional meaning for specific filter parameters beyond what the schema already states.

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 uses the imperative verb 'List' with the explicit resource 'group iterations' and mentions filtering options. It clearly communicates that this is the collection-oriented counterpart to a single-resource get tool, making it distinguishable from siblings that target one resource.

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?

It explicitly states when to use the tool: use it for a collection of resources, and directs the agent to a get tool when a single resource is already known. It does not name a specific sibling alternative, but the when-to-use guidance is clear and selection-relevant.

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