Skip to main content
Glama

sn_incident_add_comment

Append one bounded, customer-visible comment to an authorized ServiceNow incident using its sys_id, content, and profile. Use it to add controlled journal updates without exposing internal notes.

Instructions

Append one bounded customer-visible comment 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_comment"
  }
}

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.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false, and openWorldHint=true. The description adds real context beyond that: the comment is visible to the customer (an exposure consequence), it appends rather than replaces, it is bounded to one comment per call, and it requires an authorized incident.

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 no filler; the visibility qualifier and the bounded/authorized constraints all appear before any schema lookup is needed.

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?

An output schema exists and annotations cover the safety profile, so the description needn't explain return values or reversibility. It is nearly complete for a three-parameter append tool, with only the missing explicit alternative routing as a residual gap.

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%, so sys_id, content, and profile are fully documented in the schema including the hex pattern, length bounds, and the no-fallback note for profile. The description adds only the word 'bounded', so baseline 3 is appropriate.

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 description states a specific verb and resource ('Append ... comment to ... incident') and adds a distinguishing qualifier, 'customer-visible', which separates it from the internal-note sibling sn_incident_add_work_note. It stops short of naming that sibling explicitly, so differentiation is implied rather than stated.

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?

'Authorized incident' and 'one bounded' imply prerequisites (permission required, single append per call), giving some usage context. However, there is no explicit when-to-use versus when-not-to-use guidance, and no direct routing to the work-note alternative for internal-only notes.

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