Project workspace

start-sprint-tool

Activate an upcoming sprint. At most one sprint per project may be active at any time.

Activates a sprint: sets is_active=true and stamps started_at to the current time. A project may have at most one active sprint at any given time, so this tool rejects the call when another sprint on the same project is already active.

Inputs

NameTypeRequiredDescription
sprint_idintegeryesSprint to activate.

Permissions

  • project_management::manage_sprints (entry permission).
  • The user must also be allowed to manage the target sprint by SprintPolicy.

Example

{
  "sprint_id": 7
}

Response

Returns the activated sprint (same shape as create-sprint-tool's response). state is active and started_at is set.

Errors

  • An unknown sprint_id returns a validation error.
  • A sprint that is already active returns an authorization error.
  • A sprint that has been completed returns an authorization error.
  • Another sprint on the same project being active returns an authorization error.
  • A caller without project_management::manage_sprints (or who fails the model policy) receives an authorization error.

On this page