Skip to main content

Tools - Sprints

Sprints represent bounded time periods of work within a board. When a sprint is closed, completed work items are archived and a changelog and visual report are automatically generated.


list_sprints

Lists all sprints for a board. The open sprint appears first, followed by closed sprints ordered by date (most recent first).

Parameters:

NameTypeRequiredDescription
boardIdstring (UUID)YesBoard ID

Example:

{
"boardId": "b1234567-89ab-cdef-0123-456789abcdef"
}

Response:

[
{
"id": "sprint-001",
"name": "Sprint 12",
"status": "open",
"startDate": "2025-02-10T00:00:00.000Z",
"endDate": "2025-02-24T00:00:00.000Z",
"boardId": "b1234567-...",
"workItemCount": 0,
"createdAt": "2025-02-10T09:00:00.000Z"
},
{
"id": "sprint-000",
"name": "Sprint 11",
"status": "closed",
"startDate": "2025-01-27T00:00:00.000Z",
"endDate": "2025-02-09T00:00:00.000Z",
"boardId": "b1234567-...",
"workItemCount": 18,
"createdAt": "2025-01-27T09:00:00.000Z"
}
]

get_sprint

Retrieves a sprint by its ID, including the work item count.

Parameters:

NameTypeRequiredDescription
idstring (UUID)YesSprint ID

Example:

{
"id": "sprint-001"
}

get_active_sprint

Retrieves the currently open sprint for a board. Returns null if no sprint is open.

Parameters:

NameTypeRequiredDescription
boardIdstring (UUID)YesBoard ID

Example:

{
"boardId": "b1234567-89ab-cdef-0123-456789abcdef"
}

Response:

{
"id": "sprint-001",
"name": "Sprint 12",
"status": "open",
"startDate": "2025-02-10T00:00:00.000Z",
"endDate": "2025-02-24T00:00:00.000Z",
"boardId": "b1234567-...",
"workItemCount": 0
}

create_sprint

Creates a new sprint on a board. Only one open sprint is allowed per board at a time.

Parameters:

NameTypeRequiredDescription
boardIdstring (UUID)YesBoard ID
namestringYesSprint name
startDatestringNoStart date in ISO 8601 format
endDatestringNoEnd date in ISO 8601 format

Example:

{
"boardId": "b1234567-89ab-cdef-0123-456789abcdef",
"name": "Sprint 13",
"startDate": "2025-02-24",
"endDate": "2025-03-10"
}

close_sprint

Closes an open sprint. Archives all work items in "done" columns and records them as sprint work items. Optionally filters by date range. Upon closing, a visual report and changelog are automatically generated.

Parameters:

NameTypeRequiredDescription
sprintIdstring (UUID)YesID of the sprint to close
boardIdstring (UUID)YesBoard ID of the sprint
startDatestringNoISO 8601 start date to filter items by finishedAt >= startDate
endDatestringNoISO 8601 end date to filter items by finishedAt <= endDate

Example:

{
"sprintId": "sprint-001",
"boardId": "b1234567-89ab-cdef-0123-456789abcdef"
}

close_sprint_adhoc

Creates and closes a sprint in a single transaction. Useful for retroactively recording a sprint that has already been completed. Optionally filters items by date range.

Parameters:

NameTypeRequiredDescription
boardIdstring (UUID)YesBoard ID
namestringYesSprint name
startDatestringNoISO 8601 start date to filter items
endDatestringNoISO 8601 end date to filter items

Example:

{
"boardId": "b1234567-89ab-cdef-0123-456789abcdef",
"name": "Sprint 10 (retroactive)",
"startDate": "2025-01-13",
"endDate": "2025-01-26"
}

close_sprint_by_date

Creates and closes a sprint with explicit start and end dates in a single transaction. Archives all work items currently in "done" columns. Start and end dates are required.

Parameters:

NameTypeRequiredDescription
boardIdstring (UUID)YesBoard ID
namestringYesSprint name
startDatestringYesISO 8601 start date (e.g., 2025-01-01)
endDatestringYesISO 8601 end date (e.g., 2025-01-14)

Example:

{
"boardId": "b1234567-89ab-cdef-0123-456789abcdef",
"name": "Sprint 9",
"startDate": "2025-01-01",
"endDate": "2025-01-14"
}

get_sprint_work_items

Lists all completed and archived work items in a specific sprint.

Parameters:

NameTypeRequiredDescription
sprintIdstring (UUID)YesSprint ID

Example:

{
"sprintId": "sprint-000"
}

preview_done_items

Previews the work items in "done" columns that would be archived when closing a sprint. Useful for reviewing before executing close_sprint.

Parameters:

NameTypeRequiredDescription
boardIdstring (UUID)YesBoard ID

Example:

{
"boardId": "b1234567-89ab-cdef-0123-456789abcdef"
}

Response:

[
{
"id": "wi-001",
"taskId": "A-T-37",
"title": "Implement login",
"type": "task",
"columnName": "Done",
"finishedAt": "2025-02-20T15:30:00.000Z"
},
{
"id": "wi-002",
"taskId": "A-T-38",
"title": "Auth integration tests",
"type": "task",
"columnName": "Done",
"finishedAt": "2025-02-21T10:00:00.000Z"
}
]
Recommended flow

Before closing a sprint, run preview_done_items to verify that the correct items will be archived. Then execute close_sprint or close_sprint_adhoc.


regenerate_sprint_changelog

Regenerates the changelog document for a closed sprint. Useful for regenerating after prompt improvements or for older sprints that lack a changelog.

Parameters:

NameTypeRequiredDescription
sprintIdstring (UUID)YesSprint ID (must be closed)
fallbackStrategystringNoStrategy for items without AI documentation: list-only (default, lists without summary), ai-analyze (generates AI summaries on the fly), skip (omits items without documentation)

Example:

{
"sprintId": "sprint-000",
"fallbackStrategy": "ai-analyze"
}

Response:

{
"message": "Changelog generated successfully for sprint 'Sprint 11'",
"documentId": "doc-uuid-001"
}