Skip to main content
Glama

Incident: add an update

incident_update

Add a timestamped update to an open incident, and optionally mark a notification as made. Each update is hash-chained, so the timeline cannot be rewritten later. Requires the organization API key.

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": {
      "incident_id": "<incident_id>",
      "note": "<note>",
      "actor": "<actor>"
    },
    "name": "incident_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteYesWhat was found or done
actorYesWho is doing this (person or agent)
incident_idYes
material_atNoSEC only: set when materiality is decided
completed_stepNoA notification you just made, e.g. gdpr.authority_notification, nis2.early_warning, sec_8k.form_8k, contract.notify

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare the write/non-idempotent/open-world profile, so the description earns credit for adding audit semantics: updates are hash-chained and the timeline cannot be rewritten later. It also discloses the org-API-key auth requirement, which annotations do not convey. It stops short of describing failure behavior or what happens to the incident's overall state.

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?

Two sentences with no filler, and the core action plus its primary effect are front-loaded before the immutability and auth notes. Every sentence carries distinct information.

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 5-parameter mutation tool with annotations and no output schema, the description covers purpose, precondition, auth, and durability consequences. Minor gaps remain around state effects and error behavior, but nothing critical to invoking it correctly is missing.

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 80%, so the schema already documents note, actor, material_at, and completed_step. The description only loosely maps 'mark a notification as made' to completed_step and adds no syntax, format, or constraint detail beyond the schema, so baseline 3 applies.

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 ('Add a timestamped update'), a specific resource ('open incident'), and a secondary effect ('optionally mark a notification as made'). The 'open incident' scoping plus the notification-marking side effect make it distinguishable from incident_open/incident_close/incident_status without opening a schema.

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?

Gives a precondition (the incident must be open) and an access requirement ('Requires the organization API key'), which is real usage context. However, it offers no explicit when-not guidance and does not route the agent to siblings such as incident_status or incident_close for related operations.

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