Skip to content
This page was generated and translated with the assistance of AI. If you spot any inaccuracies, feel free to help improve it. Edit on GitHub

Sprint Management ​

Sprints are time-boxed iterations for organizing and tracking work. Each sprint belongs to a project and has a start date, end date, and a set of assigned issues.

Creating a Sprint ​

Via the Web UI ​

  1. Navigate to your project.
  2. Go to the Sprints section.
  3. Click New Sprint.
  4. Enter the sprint name, start date, and end date.

Via the API ​

bash
curl -X POST http://localhost:8080/api/projects/<project_id>/sprints \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "name": "Sprint 1",
    "start_date": "2026-03-24",
    "end_date": "2026-04-07"
  }'

Via MCP ​

json
{
  "method": "tools/call",
  "params": {
    "name": "sprints.create",
    "arguments": {
      "project_id": "<project_uuid>",
      "name": "Sprint 1",
      "start_date": "2026-03-24",
      "end_date": "2026-04-07"
    }
  }
}

Sprint Fields ​

FieldTypeRequiredDescription
NamestringYesSprint name (e.g., "Sprint 1", "Q1 Week 3")
Start DatedateNoSprint start date
End DatedateNoSprint end date
StatusenumAutoActive, completed, or planned

Assigning Issues to Sprints ​

Assign issues to a sprint by updating the issue's sprint_id:

bash
curl -X PATCH http://localhost:8080/api/issues/<issue_id> \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{"sprint_id": "<sprint_uuid>"}'

Or via the web UI, drag issues into the sprint section or use the issue detail panel.

Sprint Planning Workflow ​

A typical sprint planning workflow:

  1. Create the sprint with start and end dates.
  2. Review the backlog -- identify issues to include.
  3. Move issues from Backlog/To Do into the sprint.
  4. Set priorities and assignees for sprint issues.
  5. Start the sprint -- team begins work.
  6. Track progress on the board and sprint view.
  7. Complete the sprint -- review done/remaining items.

MCP Tools ​

ToolParamsDescription
sprints.listproject_idList sprints in a project
sprints.createproject_id, nameCreate a sprint with optional dates
sprints.updatesprint_idUpdate name, dates, or status
sprints.deletesprint_idDelete a sprint

Next Steps ​

Released under the Apache-2.0 License.