Skip to main content
Glama

sn_incident_add_work_note

Append one bounded internal work note to an authorized ServiceNow incident using its sys_id, note content, and configured profile.

Instructions

Append one bounded internal work note to an authorized incident.

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": {
      "sys_id": "<sys_id>",
      "content": "<content>",
      "profile": "<profile>"
    },
    "name": "sn_incident_add_work_note"
  }
}

Input Schema

NameRequiredDescriptionDefault
sys_idYesThe 32-hex sys_id of the incident to append to.
contentYesJournal text; 1-8000 characters and at most 16384 UTF-8 bytes.
profileYesConfigured ServiceNow profile name (required; no default fallback).

Output Schema

NameRequiredDescriptionDefault
dataYes
profileYesConfigured ServiceNow profile name (required; no default fallback).
metadataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.2.0

TDQS

A3.7/5.0
Behavior4/5

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

Beyond the annotations, it discloses that notes are append-only (nothing existing is overwritten), internal-only in visibility, size-bounded, and restricted to an 'authorized' incident. It does not address failure behavior or whether notes are editable afterward, but the added context is substantive.

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 clause with no filler; the mutation ('append') and the scope ('internal work note', 'authorized incident') are front-loaded.

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

Completeness3/5

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

Annotations and a complete schema plus an output schema carry most of the load, so the terse description is workable. The missing piece is routing guidance against the sibling comment tool, which the description leaves to inference.

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 coverage is 100%, so sys_id, content limits, and the required profile are already fully documented. The description adds only the notion of a bounded append, no additional per-parameter meaning.

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 verb 'append' and resource 'internal work note' on an 'incident' state exactly what is created and where. The word 'internal' implicitly separates it from customer-visible commenting, though it never names a sibling explicitly.

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?

'internal' hints at the when-to-use case (non-customer-facing notes) but the description never states when to prefer this over an incident comment or what exclusions apply. Usage is inferable rather than instructed.

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