Edit a planned release — name, production date, milestones, gate items, description, release note (project admin or release manager; D189: an AI agent only name, date, milestones, description before the baseline is locked; D198: the release note while planned).
update_releaseEdit a planned release — name, production date, milestones, gate items, description, release note (project admin or release manager; D189: an AI agent only name, date, milestones, description before the baseline is locked; D198: the release note while planned).
gate is the complete new list: items kept by id keep their ticks (done_by / done_at); a released release → 409 release_released. D189: an agent token may change only name, target_date, milestones and body, and only while the release is planned and its baseline is not locked — gate from an agent, or a baselined release → 403 agent_forbidden (people decide after the baseline). D198 (2): release_note is the release note, kept apart from body. People who manage releases may change it in any state — on a released release release_note is the only field accepted (anything else → 409 release_released). An agent token may change release_note while the release is planned, also after the baseline is locked (a release note is not scope); with any other field the D189 rule above applies.
Edit a planned release's name, target_date, milestones or body (D189): get_release first and pass its frontmatter.version, change only what the user asked, give a reason. release_note (D198) is the customer-facing release note (Markdown ≤ 50 000), kept apart from the internal description body; every member who can open the release reads it. You may write it while the release is planned, also after a person has locked the baseline (a note is not scope); "" clears it. Once a person has locked the baseline, for the gate, or with any other field after the lock, you get 403 agent_forbidden — stop and tell the user a release manager changes it in the web app. A released release → 409 release_released (a release manager can still edit its release_note in the web app).
WRITE: version = from your latest read (get_issue, list_comments, list_sprints, get_doc, read_file). 409 version_conflict (details.current, details.current_version): re-read, re-apply your change, retry — never overwrite blindly; when the changes disagree, ask the user.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_key": "<project_key>",
"release_id": "<release_id>",
"version": "<version>"
},
"name": "update_release"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | ||
| gate | No | The complete gate list. New manual items get an id from the title when `id` is missing. | |
| name | No | ||
| reason | No | Spec D144: why you make this change (≤ 200 characters). Optional, but give it when you act as an agent account — it is shown in the agent's run log ("moved KJ-12 To Do → In Progress because <reason>"). board-mcp records it in `agent.run`; board-core / board-files accept it and ignore it (it never changes the file, the version or the history). | |
| version | Yes | Optimistic-lock version of the file; +1 on every write. Every write must send the version it read. | |
| milestones | No | ||
| release_id | Yes | Release id (spec D113): `R-` + a number, unique in its project; the file is `releases/R-{n}.md`. | |
| project_key | Yes | Project key, e.g. `KJ`. 2–10 chars, uppercase letters and digits, starts with a letter. | |
| target_date | No | Calendar date `YYYY-MM-DD` (Asia/Bangkok). | |
| release_note | No | D198 (2): the release note (Markdown), apart from `body`; every member who can open the release sees it. "" clears it. |