Edit a release, or write its release notes

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

What it does

Changes a release, sprint or milestone: name, version, kind, dates, status (planned or active only; use release.ship / release.cancel for the others) and the release notes (markdown, replaces what is there). Send only the fields to change. For release notes, read release.readiness for the linked features and test results and write from those; show the user the notes before saving when they already have some. The release must belong to the connected workspace. Returns {success, data: the updated release}.

Ask your agent

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

  • “Set the version of the June release to 2.4.0”
  • “Write the release notes for v2.4 from what shipped”
  • “Mark Sprint 24 as active”

Inputs

NameTypeDescription
releaseId
required
stringId of the release (the id from release.list).
name
optional
stringNew display name.
version
optional
string | nullVersion, e.g. "2.4.0"; null clears it.
kind
optional
enumrelease, sprint or milestone.
Allowed: releasesprintmilestone
status
optional
enumplanned or active.
Allowed: plannedactive
startDate
optional
string | nullYYYY-MM-DD; null clears it.
targetDate
optional
string | nullYYYY-MM-DD; null clears it.
releaseNotes
optional
string | nullRelease notes, markdown; replaces the current notes.
releaseNotesUrl
optional
string | nullLink to an external changelog; null clears it.

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.update",
    "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.