Mark a release as shipped

release.shipChanges dataCreates, updates or deletes something in your workspace.

What it does

Records that a release, sprint or milestone is done and out: sets status to "shipped", stamps shippedAt and records who shipped it. Use it once the user confirms the release went live. It is refused while the ship gate fails (see release.readiness: at least one test run linked, no high-priority or high-severity case failing or left unexecuted, no open high-severity defect); the error lists what blocks it. Only a person (admin or owner) can ship past a failing gate, with a reason, on the Releases page, never an agent. It deploys nothing and does not change the linked features; move finished features to "live" with feature.set_lifecycle. A cancelled release cannot ship. The release must belong to the connected workspace. Returns {success, data: the updated release}.

Ask your agent

You don’t call release.ship yourself. Say something like this to Claude Code, Cursor or another MCP-connected agent:

  • “We just shipped v2.0, record it”
  • “Close out Sprint 23 as done”

Inputs

NameTypeDescription
releaseId
required
stringId of the release, sprint or milestone (the id from release.list).

The MCP call

What the agent’s MCP client sends (placeholders in angle brackets):

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "release.ship",
    "arguments": {
      "releaseId": "<releaseId>"
    }
  }
}

Connect your agent

npx -y @testmaze/mcp init tmt_xxx
claude mcp add tm --scope project -- npx -y @testmaze/mcp

Create the token in your Test Maze workspace under Settings → MCP. Setup for Cursor, Cline, Gemini CLI and Codex CLI is shown there too.