OpenProject CE MCP Server

Overview Schema Source Related Servers Discussions Admin

List sprints

list_sprints

Read-onlyIdempotent

List Scrum sprints to find sprint IDs for assigning work packages and to review a project's sprint plan by planning, active, or completed status.

Instructions

List sprints (Scrum timeboxes) you can plan work packages into.

Use it to turn "Sprint 11" into the sprint id that create_work_package/update_work_package consume via their sprint parameter, or to review a project's sprint plan with its in_planning/active/completed states.

Returns the standard list envelope: items of {id, name, description, start_date, finish_date, workspace, status} plus pagination and notes. A project-scoped listing is fetched in full, so has_more is false; the instance-wide listing is paginated.

Pitfalls: sprints are not versions (17.3+): finish_date is the wire finishDate and status is the sprint lifecycle. Assign work with update_work_package(sprint=...); the API has no sprint write endpoint.

Cross-references: get_sprint for one sprint in full; list_versions for releases and milestones; list_work_packages with sprint_ids to see what is IN a sprint.

Input Schema

Name	Required	Description
`page`	No	1-based page number.
`page_size`	No	Sprints per page (max 100).
`project_id`	No	Numeric project id or URL identifier to list the sprints of that project (native or shared). Omit it to list every sprint visible to you across the instance.

Output Schema

Name	Required	Description	Default
`sums`	No
`items`	No
`notes`	No
`groups`	No
`pagination`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed41 schema fields changedv0.4.0Oct 24, 2026

changedOutput schema / properties / groups / anyOf

Previous value: -[
-  {
-    "items": {
-      "description": "A server-side group bucket, computed over the full filtered set.",
-      "properties": {
-        "count": {
-          "default": 0,
-          "description": "Records in this group across all pages.",
-          "type": "integer"
-        },
-        "sums": {
-          "anyOf": [
-            {
-              "additionalProperties": {
-                "type": "number"
-              },
-              "type": "object"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "default": null,
-          "description": "Per-group sums when show_sums was requested."
-        },
-        "value": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "null"
-            }
-          ],
-          "default": null,
-          "description": "Group value, e.g. a status name."
-        }
-      },
-      "type": "object"
-    },
-    "type": "array"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "items": {
+      "properties": {
+        "count": {
+          "type": "integer"
+        },
+        "sums": {
+          "anyOf": [
+            {
+              "additionalProperties": {
+                "type": "number"
+              },
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "value": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "type": "array"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / groups / default
```
Removed value: -null
```

removedOutput schema / properties / groups / description

Removed value: -"Present only when group_by was requested."

removedOutput schema / properties / items / description
```
Removed value: -"The page of results."
```
removedOutput schema / properties / items / items / description
```
Removed value: -"One sprint as list results return it."
```

removedOutput schema / properties / items / items / properties / description / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

removedOutput schema / properties / items / items / properties / description / default
```
Removed value: -null
```
removedOutput schema / properties / items / items / properties / description / description
```
Removed value: -"Description as markdown (raw); html is dropped."
```
addedOutput schema / properties / items / items / properties / description / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / items / items / properties / finish_date / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

removedOutput schema / properties / items / items / properties / finish_date / default
```
Removed value: -null
```
removedOutput schema / properties / items / items / properties / finish_date / description
```
Removed value: -"ISO date (YYYY-MM-DD); the sprint's finish date (wire 'finishDate')."
```
addedOutput schema / properties / items / items / properties / finish_date / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / items / items / properties / id / anyOf

Removed value: -[
-  {
-    "type": "integer"
-  },
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

removedOutput schema / properties / items / items / properties / id / default
```
Removed value: -null
```

removedOutput schema / properties / items / items / properties / id / description

Removed value: -"Sprint id — what the work-package 'sprint' field consumes."

addedOutput schema / properties / items / items / properties / id / type
```
Added value: +[
+  "integer",
+  "string",
+  "null"
+]
```

removedOutput schema / properties / items / items / properties / name / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

removedOutput schema / properties / items / items / properties / name / default
```
Removed value: -null
```
removedOutput schema / properties / items / items / properties / name / description
```
Removed value: -"Sprint name, e.g. 'Sprint 11'."
```
addedOutput schema / properties / items / items / properties / name / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / items / items / properties / start_date / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

removedOutput schema / properties / items / items / properties / start_date / default
```
Removed value: -null
```
removedOutput schema / properties / items / items / properties / start_date / description
```
Removed value: -"ISO date (YYYY-MM-DD)."
```
addedOutput schema / properties / items / items / properties / start_date / type
```
Added value: +[
+  "string",
+  "null"
+]
```

removedOutput schema / properties / items / items / properties / status / anyOf

Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]

removedOutput schema / properties / items / items / properties / status / default
```
Removed value: -null
```
removedOutput schema / properties / items / items / properties / status / description
```
Removed value: -"in_planning, active or completed (parsed from the status URN)."
```
addedOutput schema / properties / items / items / properties / status / type
```
Added value: +[
+  "string",
+  "null"
+]
```

changedOutput schema / properties / items / items / properties / workspace / anyOf

Previous value: -[
-  {
-    "additionalProperties": false,
-    "description": "A reference to another resource. Canonical output shape.",
-    "properties": {
-      "id": {
-        "anyOf": [
-          {
-            "type": "integer"
-          },
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "default": null,
-        "description": "Resource id."
-      },
-      "name": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ],
-        "default": null,
-        "description": "Human-readable name."
-      }
-    },
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "id": {
+        "type": [
+          "integer",
+          "string",
+          "null"
+        ]
+      },
+      "name": {
+        "type": [
+          "string",
+          "null"
+        ]
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / items / items / properties / workspace / default
```
Removed value: -null
```
removedOutput schema / properties / items / items / properties / workspace / description
```
Removed value: -"The project (workspace) that DEFINES the sprint."
```
removedOutput schema / properties / notes / default
```
Removed value: -null
```

removedOutput schema / properties / notes / description

Removed value: -"Degradation markers: capped aggregations, unavailable modules, …"

removedOutput schema / properties / pagination / description
```
Removed value: -"Total/page/page_size/has_more."
```
removedOutput schema / properties / pagination / properties / has_more / description
```
Removed value: -"True when further pages exist."
```
removedOutput schema / properties / pagination / properties / page / description
```
Removed value: -"1-based page number of this result."
```
removedOutput schema / properties / pagination / properties / page_size / description
```
Removed value: -"Records requested per page."
```
removedOutput schema / properties / pagination / properties / total / description
```
Removed value: -"Total matching records on the server."
```
removedOutput schema / properties / sums / default
```
Removed value: -null
```

removedOutput schema / properties / sums / description

Removed value: -"Present only when show_sums was requested."

Addedv0.3.3Oct 3, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already declare readOnly/idempotent, but the description adds behavior they don't: project-scoped listings return everything (has_more false) while instance-wide listings paginate, finish_date maps to the wire finishDate, and critically there is no sprint write endpoint so assignment must go through update_work_package. That last point prevents a whole class of failed calls.

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-loads the definition and use case, then separates return shape, pitfalls, and cross-references into scannable blocks. Somewhat long for a three-parameter list tool, and the wire-format note on finishDate is close to incidental, but nearly every sentence carries routing or behavioral information.

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?

Even though an output schema exists, the description sketches the items envelope and pagination/notes fields, and it closes the loop on the most likely agent error (trying to write a sprint). For a read-only list tool with full schema coverage, nothing an agent needs to call it correctly is missing.

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 100%, so baseline is 3; the description earns above that by explaining the consequence of project_id's omission — full instance-wide enumeration versus a complete per-project fetch — which changes how an agent should page. Page/page_size are left entirely to the schema.

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+resource ("List sprints (Scrum timeboxes)") and immediately contrasts sprints against versions and other list tools. An agent can distinguish this from list_versions and get_sprint without opening any schema.

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

Usage Guidelines5/5

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

Gives two concrete use cases (resolve "Sprint 11" to an id for create/update_work_package, review a project's sprint plan) and explicitly names alternatives: get_sprint for a single sprint, list_versions for releases, list_work_packages with sprint_ids for contents. When-to-use and when-to-use-something-else are both covered.

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

Deploy Server