Skip to main content
Glama

update_report

Idempotent

Update authored report fields with expectedVersion and an idempotencyKey; existing paragraphs and untouched fields are preserved.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNo
titleNo
outcomeNoOptional scoped outcome. At most 8 criteria, 8 observations per criterion, and 16000 serialized UTF-8 bytes including retained criterion wording. All scope/revision/result values are recorded claims.
summaryNo
reportIdYesOwned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL.
projectIdYesOwned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL.
sessionIdNoOwned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL.
attachmentsNo
executionIdNoOwned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL.
idempotencyKeyYesCaller-generated retry key. Reuse the same key and identical payload only to retry the same mutation; use a new key for a new action.
expectedVersionYesCurrent version of the target record from its latest read or mutation result. A stale value causes a version conflict; re-read before retrying.
markOutcomeReviewedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changed
    • changedInput schema / properties / attachments / items / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "data": {
      -        "maxLength": 6990508,
      -        "type": "string"
      -      },
      -      "name": {
      -        "maxLength": 180,
      -        "minLength": 1,
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "name",
      -      "data"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "id": {
      -        "maxLength": 200,
      -        "minLength": 1,
      -        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:@+~-]*$",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "id"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "data": {
      +        "maxLength": 6990508,
      +        "type": "string"
      +      },
      +      "name": {
      +        "maxLength": 180,
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "name",
      +      "data"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "id": {
      +        "description": "Owned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL.",
      +        "maxLength": 200,
      +        "minLength": 1,
      +        "pattern": "^[A-Za-z0-9][A-Za-z0-9._:@+~-]*$",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "id"
      +    ],
      +    "type": "object"
      +  }
      +]
    • addedInput schema / properties / executionId / description
      Added value: +"Owned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL."
    • addedInput schema / properties / expectedVersion / description
      Added value: +"Current version of the target record from its latest read or mutation result. A stale value causes a version conflict; re-read before retrying."
    • addedInput schema / properties / idempotencyKey / description
      Added value: +"Caller-generated retry key. Reuse the same key and identical payload only to retry the same mutation; use a new key for a new action."
    • addedInput schema / properties / projectId / description
      Added value: +"Owned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL."
    • addedInput schema / properties / reportId / description
      Added value: +"Owned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL."
    • addedInput schema / properties / sessionId / description
      Added value: +"Owned project ID returned by list_linked_projects or map_project; do not use a local path or repository URL."
  2. Changed1 schema field changed
    • changedInput schema / properties / outcome / properties / resourceObservations / items / properties / coverage / enum
      Previous value: -[
      -  "turn",
      -  "cumulative",
      -  "operation"
      -]New value: +[
      +  "turn",
      +  "cumulative",
      +  "operation",
      +  "increment"
      +]
  3. Changed4 schema fields changed
    • addedInput schema / properties / outcome / properties / mission
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "id": {
      +      "maxLength": 70,
      +      "minLength": 1,
      +      "pattern": "^focus_[A-Za-z0-9_-]{1,64}$",
      +      "type": "string"
      +    },
      +    "intent": {
      +      "maxLength": 4000,
      +      "minLength": 0,
      +      "type": "string"
      +    },
      +    "name": {
      +      "maxLength": 120,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "nodeIds": {
      +      "items": {
      +        "maxLength": 160,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "maxItems": 64,
      +      "minItems": 0,
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "name",
      +    "nodeIds"
      +  ],
      +  "type": "object"
      +}
    • addedInput schema / properties / outcome / properties / references
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "changeReviewId": {
      +      "maxLength": 160,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "sessionId": {
      +      "maxLength": 160,
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "taskId": {
      +      "maxLength": 160,
      +      "minLength": 1,
      +      "type": "string"
      +    }
      +  },
      +  "required": [],
      +  "type": "object"
      +}
    • addedInput schema / properties / outcome / properties / resourceObservations
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "coverage": {
      +        "enum": [
      +          "turn",
      +          "cumulative",
      +          "operation"
      +        ],
      +        "type": "string"
      +      },
      +      "id": {
      +        "maxLength": 160,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "kind": {
      +        "enum": [
      +          "tokens",
      +          "cost",
      +          "retries",
      +          "validation_effort",
      +          "support_effort"
      +        ],
      +        "type": "string"
      +      },
      +      "reference": {
      +        "maxLength": 500,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "sessionId": {
      +        "maxLength": 160,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "source": {
      +        "enum": [
      +          "measured",
      +          "estimated",
      +          "unknown"
      +        ],
      +        "type": "string"
      +      },
      +      "taskId": {
      +        "maxLength": 160,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "turnId": {
      +        "maxLength": 160,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "unit": {
      +        "maxLength": 80,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "value": {
      +        "minimum": 0,
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      }
      +    },
      +    "required": [
      +      "id",
      +      "kind",
      +      "value",
      +      "unit",
      +      "source",
      +      "reference"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 64,
      +  "minItems": 0,
      +  "type": "array"
      +}
    • addedInput schema / properties / outcome / properties / scopeExplanations
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "explanation": {
      +        "maxLength": 1000,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "path": {
      +        "maxLength": 240,
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "reference": {
      +        "maxLength": 500,
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "path",
      +      "explanation",
      +      "reference"
      +    ],
      +    "type": "object"
      +  },
      +  "maxItems": 32,
      +  "minItems": 0,
      +  "type": "array"
      +}
  4. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already cover readOnly=false, destructive=false, idempotent=true, closed-world. The description adds genuine patch semantics ('existing paragraphs and untouched fields are preserved'), which is real behavioral value beyond the annotations. It does not, however, mention auth/permission requirements or what a version conflict returns.

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?

A single dense sentence with the mutation and the preservation guarantee front-loaded; no filler. It is terse for a 12-parameter nested tool, but nothing in it is wasted.

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

Completeness2/5

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

For a 12-parameter, deeply nested mutation with no output schema and no title, the description leaves a lot unaddressed: how the large nested outcome object interacts with partial updates, what attachments do, and what happens on version conflict are all undisclosed. Only the required optimistic-concurrency and idempotency mechanics are signaled.

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

Parameters3/5

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

Schema description coverage is 58%, and the description only echoes expectedVersion and idempotencyKey, both of which the schema already documents in detail. It adds no meaning for the other 10 parameters (body, outcome, attachments, executionId, markOutcomeReviewed, etc.), so it neither compensates for the coverage gap nor adds value over 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?

States a specific verb+resource ('Update authored report fields') and names distinguishing mechanics (expectedVersion, idempotencyKey). It implicitly separates itself from create_report/get_report by being a mutation of existing fields, but never explicitly names those siblings.

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 implied: this is for modifying an already-authored report, and untouched fields are preserved. However, there is no explicit when-to-use, when-not-to-use, or routing to siblings like create_report, get_report, or queue_report.

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