Skip to main content
Glama

Get an incident update

get_incident_update
Read-onlyIdempotent

Get an incident update by ID, with its state, message, publication date and author.

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_id": "<project_id>",
      "incident_id": "<incident_id>",
      "incident_update_id": "<incident_update_id>"
    },
    "name": "get_incident_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idYesID of the project to act on, see whoami
incident_idYesID of the incident
incident_update_idYesID of the incident update to show

Output Schema

NameRequiredDescriptionDefault
idNoIncident update ID
stateNoState of the incident update
contentNoContent of the incident update
creatorNoCreator of the incident update
created_atNoDate of creation for the entity
updated_atNoDate of last update for the entity
published_atNoDate of publication of the incident update, defaults to the current date on creation. Must be within the last year and no more than 10 minutes in the future.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "content": {
      +      "description": "Content of the incident update",
      +      "examples": [
      +        "We are investigating the issue."
      +      ],
      +      "type": "string"
      +    },
      +    "created_at": {
      +      "description": "Date of creation for the entity",
      +      "format": "date-time",
      +      "type": "string"
      +    },
      +    "creator": {
      +      "description": "Creator of the incident update",
      +      "properties": {
      +        "id": {
      +          "description": "Creator ID",
      +          "examples": [
      +            1
      +          ],
      +          "type": "integer"
      +        },
      +        "label": {
      +          "description": "Creator label",
      +          "examples": [
      +            "nicolas@phare.io"
      +          ],
      +          "type": "string"
      +        },
      +        "type": {
      +          "description": "Creator type",
      +          "enum": [
      +            "user",
      +            "api_key"
      +          ],
      +          "examples": [
      +            "user"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "id": {
      +      "description": "Incident update ID",
      +      "examples": [
      +        1
      +      ],
      +      "type": "integer"
      +    },
      +    "published_at": {
      +      "description": "Date of publication of the incident update, defaults to the current date on creation. Must be within the last year and no more than 10 minutes in the future.",
      +      "format": "date-time",
      +      "type": "string"
      +    },
      +    "state": {
      +      "description": "State of the incident update",
      +      "enum": [
      +        "unknown",
      +        "investigating",
      +        "identified",
      +        "monitoring",
      +        "resolved"
      +      ],
      +      "type": "string"
      +    },
      +    "updated_at": {
      +      "description": "Date of last update for the entity",
      +      "format": "date-time",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world behavior, so the safety profile is fully covered elsewhere. The description adds only a listing of returned attributes, which is largely redundant given the output schema; it says nothing about what happens when an ID doesn't exist or belongs to another project.

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 front-loaded sentence that identifies the resource, the lookup key, and the payload in one pass. No filler, though the field enumeration is somewhat redundant with the output schema.

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 simple single-record getter with full annotations, complete parameter documentation, and an output schema, the description covers what an agent needs to invoke it correctly. Only the absence of sibling routing guidance keeps it from being fully complete.

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 100%, with each of project_id, incident_id, and incident_update_id documented in the schema itself. The description adds no extra meaning such as ID provenance or lookup order, so the baseline of 3 applies.

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 and resource ('Get an incident update by ID') and enumerates the returned fields (state, message, publication date, author). It is clearly distinguishable from create/update/delete_incident_update, though it does not explicitly contrast with list_incident_updates.

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 phrase 'by ID' implies the caller already has an identifier, which is weak indirect guidance. The description never states when to use this instead of list_incident_updates (to find an unknown update) or get_incident (for the parent incident), and no prerequisites or error conditions are mentioned.

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