Skip to main content
Glama

list_sprints

Read-onlyIdempotent

Lists Backlogs sprints visible to the current token, optionally filtered by project or name search; page results using offset.

Instructions

List Backlogs sprints, optionally filtered by name search.

Omit project to list every sprint visible to the current token across all projects; pass it to list only sprints for that project.

Requires the OpenProject Backlogs module and OpenProject 17.3 or newer; unavailable instances return a clear not-found message.

total is only the count of allowed sprints returned on THIS page, not a full count of all matches; the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Input Schema

NameRequiredDescriptionDefault
limitNoPage size, capped at OPENPROJECT_MAX_PAGE_SIZE.
offsetNo1-based page number; pass the previous result's next_offset.
searchNo
selectNoFields to return; a requested unset field comes back as null. Allowed: created_at, defining_workspace, defining_workspace_id, finish_date, id, name, start_date, status, updated_at.
projectNoProject identifier, id, or name; a unique part of a name or identifier also matches.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.4.4
  2. Removedv0.4.0
  3. Changed1 schema field changedv0.3.7
    • addedInput schema / additionalProperties
      Added value: +false
  4. Addedv0.3.3

TDQS

A4.2/5.0
Behavior5/5

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

With readOnly/idempotent annotations already covering the safety profile, the description adds real context beyond them: Backlogs module and OpenProject 17.3 prerequisites, the behavior on unsupported instances (clear not-found), and the caveat that total reflects only the current page because the search short-circuits. That is exactly the kind of non-obvious behavior an agent needs.

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 with the core action in the first line, then prerequisites, then pagination semantics. Efficient overall, though the explanation of why total is inexact is slightly wordy for the value it adds.

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?

No output schema, so spelling out total and next_offset semantics is necessary and done well, and select's allowed fields cover the return shape. Environment prerequisites are covered; only per-field return detail is left implicit.

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 80%, so limit/offset/select are already documented. The description still adds meaning for project (omitted = cross-project listing) and for search (name matching) — the two parameters the schema leaves bare — plus the next_offset paging contract.

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?

Specific verb+resource: "List Backlogs sprints, optionally filtered by name search." Scope is clear and it is distinguishable from get_sprint (single) and list_backlog_buckets (different resource), though those siblings are never named explicitly.

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?

Explicitly states the when-to-use rule for the project parameter: omit it to list every sprint visible to the token across all projects, pass it to scope to one project. It also gives pagination guidance ("Page until next_offset is null") but doesn't point to an alternative tool for single-sprint lookups or other listing facets.

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