Skip to main content
Glama

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_release

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).

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

NameRequiredDescriptionDefault
bodyNo
gateNoThe complete gate list. New manual items get an id from the title when `id` is missing.
nameNo
reasonNoSpec 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).
versionYesOptimistic-lock version of the file; +1 on every write. Every write must send the version it read.
milestonesNo
release_idYesRelease id (spec D113): `R-` + a number, unique in its project; the file is `releases/R-{n}.md`.
project_keyYesProject key, e.g. `KJ`. 2–10 chars, uppercase letters and digits, starts with a letter.
target_dateNoCalendar date `YYYY-MM-DD` (Asia/Bangkok).
release_noteNoD198 (2): the release note (Markdown), apart from `body`; every member who can open the release sees it. "" clears it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / release_note
      Added value: +{
      +  "description": "D198 (2): the release note (Markdown), apart from `body`; every member who can open the release sees it. \"\" clears it.",
      +  "maxLength": 50000,
      +  "type": "string"
      +}
  2. Added

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false) it discloses the real behaviour: gate is a full replacement list where items matched by id keep their ticks, "" clears release_note, and specific error codes 403 agent_forbidden / 409 release_released / 409 version_conflict with retry guidance. The one gap is that the wholesale replacement of `gate` and clearing of `release_note` are arguably destructive in effect while destructiveHint is false, though the effect is versioned and recoverable, so this is a caution rather than a contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first sentence is a verbatim copy of the title, and the D189 baseline-lock / 403 agent_forbidden rule is stated at least twice while the release_note rule is restated three times. The 409 version_conflict retry advice also duplicates the `version` schema description. The content is front-loaded and correct, but substantial trimming would lose nothing.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with a 10-parameter schema and no output schema, the description covers permissions, state preconditions, error codes and the read-before-write version flow, which is what an agent needs to act safely. The only omission is any indication of what a successful response looks like, which matters less given the heavy error-path detail.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 70% schema coverage the schema documents types and patterns, but the description adds genuine meaning: gate keeps ticks by id and new items get an id from the title, release_note is the customer-facing Markdown kept apart from the internal `body`, and version must come from the latest read with a stated 409 recovery procedure. The `reason` parameter is only nudged ('give a `reason`') rather than explained, which is why this is not a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence names a specific verb (Edit) and resource (a planned release) and enumerates the editable fields, so an agent can immediately tell this apart from create_release, get_release, add_to_release and move_to_release. The field list plus the actor/state restrictions makes the scope unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It spells out exactly when a call is allowed and when it is not: agent tokens only for name/target_date/milestones/body while planned and unlocked, release_note also after the baseline lock, gate only for people, and a released release accepts only release_note. It names the concrete fallback path (403 agent_forbidden → stop and tell the user a release manager edits it in the web app) and tells the agent to call get_release first.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources