Skip to main content
Glama

Update goal

update_goal

Update a goal — only include the fields you want to change.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesGoal ID (from list_goals)
nameNoGoal name
queryNoThe metric query the goal measures — replaces the stored one outright
symbolNoDisplay format: numbers, decimal, % or currency; null clears it
operatorNoSuccess comparison: >= (at or above), = (equal), <= (at or below)
client_idNoBind the goal to a client (from list_clients); null makes it account-wide
goal_typeNostatic (fixed target) or change (delta over the period)
descriptionNoOptional description; null clears it
target_valueNoTarget value to measure against

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoThe goal as saved, with every field after the update applied.
successYesTrue when the call succeeded. A failure comes back as an error result instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changed
    • addedInput schema / properties / client_id / description
      Added value: +"Bind the goal to a client (from list_clients); null makes it account-wide"
    • addedInput schema / properties / description / description
      Added value: +"Optional description; null clears it"
    • addedInput schema / properties / goal_type / description
      Added value: +"static (fixed target) or change (delta over the period)"
    • addedInput schema / properties / name / description
      Added value: +"Goal name"
    • addedInput schema / properties / operator / description
      Added value: +"Success comparison: >= (at or above), = (equal), <= (at or below)"
    • changedInput schema / properties / query / description
      Previous value: -"Saved builder query the goal is measured against"New value: +"The metric query the goal measures — replaces the stored one outright"
    • addedInput schema / properties / symbol / description
      Added value: +"Display format: numbers, decimal, % or currency; null clears it"
    • addedInput schema / properties / target_value / description
      Added value: +"Target value to measure against"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "additionalProperties": {},
      +      "description": "The goal as saved, with every field after the update applied.",
      +      "type": "object"
      +    },
      +    "success": {
      +      "description": "True when the call succeeded. A failure comes back as an error result instead.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already indicate a non-read-only operation. The description adds the meaningful behavioral detail that this is a partial update—fields omitted are left unchanged. This prevents the agent from assuming a full replacement, which is valuable context beyond what the annotations provide. Side effects and error behavior are not mentioned, but the annotations cover the safety profile.

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

Conciseness5/5

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

A single front-loaded sentence with zero wasted words. It states the operation and the most important usage rule efficiently. No redundant repetition of schema details.

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?

Given the complex schema (9 parameters, nested query object), 100% parameter coverage, presence of an output schema, and annotations, the description provides sufficient orientation. The one omission—mentioning that prerequisites like the goal id come from list_goals—is covered by the schema's id description, so the description does not need to repeat it. The tool is well-specified overall.

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. The description adds a cross-cutting semantic: only id is required and all other fields are optional partial-update fields, meaning omitted values are preserved. This PATCH-like behavior is not explicitly stated in the schema properties and meaningfully changes how the agent should construct the request.

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 description states a specific verb ('Update') and resource ('a goal') with an added key semantic: 'only include the fields you want to change'. This clearly distinguishes it from sibling tools like create_goal, archive_goal, and duplicate_goal, and from other update_* tools for different resource types.

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

Usage Guidelines2/5

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

The description provides no guidance on when to choose this tool versus alternatives (e.g., create_goal for new goals, list_goals to obtain an id). The partial-update instruction is about how to call the tool, not when to use it. No prerequisites or exclusions are mentioned, leaving the agent to infer from the tool name.

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