Skip to main content
Glama

update_release

DestructiveIdempotent

Update a release's name, description, public changelog headline and release notes, status, target date, launch date, or color. Setting status to completed emails portal and widget submitters whose linked tasks shipped (idempotent per release, capped per project per day; manually captured signals are never emailed); setting launchDate alone sends nothing. Completing a release stamps its launch date as now unless launchDate is passed in the same call; moving it out of completed clears the date.

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": {
      "projectId": "<projectId>",
      "releaseId": "<releaseId>",
      "context": "<context>"
    },
    "name": "update_release"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew name — short (e.g. 'v1.2', 'May sprint'). Max 40 characters.
colorNoSet only when the user asks for a colour: pick the closest of #6366f1, #f97316, #22c55e, #ec4899, #06b6d4, #f59e0b, #8b5cf6, #14b8a6, #f43f5e, #3b82f6, avoiding one another release already uses (list_releases shows them), unless they give an exact 6-digit hex.
statusNoNew status. Setting active moves the current active release to upcoming.
contextYesExplain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): "Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization."
projectIdYesThe project ID
releaseIdYesThe release ID
launchDateNoLaunch date (ISO 8601) of a completed release, to backdate or correct when it really shipped. Pass null to clear. Only valid when the release is completed after this call. Publishes nothing and sends no emails.
targetDateNoNew target date (ISO 8601)
descriptionNoNew description — 1–2 short factual sentences on what this release covers and why. Keep it current as the scope changes; propose new wording in chat instead of silently rewriting one a person wrote, unless the user asked you to plan or reshape the release.
releaseNotesNoPublic release notes in markdown: an opening paragraph on why the change matters, then short sections. The changelog already lists every Done task, so don't repeat them. Pass an empty string to clear.
changelogTitleNoHeadline for the release's public changelog post, naming the main change in users' terms (e.g. 'Recurring invoices that send themselves'). Max 100 characters. Pass an empty string to fall back to the release name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Goes well past the annotations by disclosing the notification side effect of status=completed (emails portal and widget submitters, idempotent per release, capped per project per day, manually captured signals never emailed), that setting launchDate alone sends nothing, and the launch-date stamping/clearing rules. Remaining gaps are minor against annotations that already declare destructiveHint=true and idempotentHint=true.

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

Conciseness4/5

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

The first sentence front-loads the full set of mutable fields, and the rest is devoted to genuinely non-obvious side effects rather than restating the schema. The email sentence is dense with stacked parentheticals, but each clause conveys distinct behavioral information that justifies its length.

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 an 11-parameter, destructive mutation tool with no output schema, the definition covers the critical unknowns: which side effects fire, under what conditions, and how date fields behave. It stops short of saying whether the call is a partial patch (unmentioned fields preserved), what is returned, or how errors surface, but nothing essential for correct invocation is missing.

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?

Schema coverage is already 100%, so the baseline is 3; the description earns more by explaining cross-parameter behavior the schema cannot express — that completing stamps the launch date as now unless launchDate is passed in the same call, and that moving out of completed clears it. It also clarifies that launchDate is purely a backdating correction with no publication side effect.

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?

States a specific verb (update) and resource (release) and then enumerates every mutable field — name, description, changelog headline, release notes, status, target date, launch date, color — so an agent knows exactly what it can change without opening the schema. The update/create/delete split against create_release and delete_release is self-evident from the name and confirmed by the field list.

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

Usage Guidelines3/5

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

Usage is only implied: the enumerated fields tell an agent this is the tool for changing an existing release, and the description notes prerequisites such as launchDate only being valid when the release is completed after the call. There is no explicit statement of when not to use it, no pointer to get_release or list_releases for reading, and no mention of whether unlisted fields are left untouched.

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