Skip to main content
Glama

update_analysis

Update the title, project, overview, summary, or initial request of a code analysis to refine its review context. Omitted fields remain unchanged.

Instructions

Change the title, the project, the overview, the summary or the initial request of an analysis. Right after reading the diff, write the overview (objective, approach, attention_points: your global analysis of the feature) and the summary (the functional changes of the feature, one bullet per change, not one bullet per file). Give at least one field; fields left out are kept.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNoNew title.
projectNoNew project. Project the analysis belongs to: the product or feature name, used as its folder in the GUI. Reuse the exact name of an existing project (see list_analyses) for another analysis of it.
summaryNoFunctional changes of the feature, one bullet per change (e.g. "Expired tokens are refreshed once before the request fails"), not one bullet per file. Replaces the whole list; [] clears it.
approachNoOverview: how the feature achieves it (architecture choices, main flow). Replaces the current approach.
objectiveNoOverview: what the feature lets users do, from a functional point of view. When the analysis has no overview yet, give objective and approach together to create it. null removes the whole overview (approach and attention points included).
analysis_idYesId of the analysis, as returned by create_analysis or list_analyses.
request_textNoInitial request the feature answers (ticket, user prompt), shown to the reviewer. null removes the request.
request_sourceNoWhere the initial request comes from, e.g. a ticket id or URL. null clears it.
attention_pointsNoOverview: risks and points the reviewer should check first, one per string. Replaces the whole list; [] clears it. Defaults to an empty list when the overview is created without it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.13

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses partial-update semantics ('fields left out are kept') and content expectations, but says nothing about permissions, whether the analysis must exist, error behavior, or the response. Adequate but incomplete for a 9-parameter mutation tool.

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?

Three sentences, front-loaded with the field list and then content guidance. The middle sentence is dense and slightly overloaded with parentheticals, but every clause earns its place.

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?

All 9 parameters are fully documented in the schema and there is no output schema to explain, so the description only needs the workflow and patch semantics it already provides. Missing only permission/error context, which is minor here.

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 100%, so the baseline is 3, but the description adds conceptual meaning the schema lacks: that 'overview' is composed of objective+approach+attention_points, and that summary is one bullet per change, not per file. This mapping value exceeds the schema.

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

Purpose4/5

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

The description states a specific verb (change/update) plus resource (analysis) and enumerates the updatable fields (title, project, overview, summary, initial request). Purpose is unmistakable, though it does not explicitly differentiate itself from siblings like update_finding or update_explanation beyond the resource noun.

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

Usage Guidelines4/5

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

It gives real workflow context ('Right after reading the diff, write the overview... and the summary') plus the patch constraint ('Give at least one field; fields left out are kept'). It does not name alternatives, but the timing guidance is concrete and actionable.

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