Skip to main content
Glama

register_event

Creates a custom event in the ServiceNow event registry and links it to the source table that fires it, supporting scripted event-driven workflows.

Instructions

Register a new custom event in the event registry (requires SCRIPTING_ENABLED=true)

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": {
      "name": "<name>",
      "table": "<table>"
    },
    "name": "register_event"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesUnique event name (e.g. "my_app.record_created")
queueNoOptional custom event queue name
tableYesTable that fires this event (e.g. "incident")
fired_byNoOptional note on what fires the event (e.g. a business rule name)
descriptionNoDescription of when this event fires

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv5.0.1
    • addedInput schema / properties / fired_by
      Added value: +{
      +  "description": "Optional note on what fires the event (e.g. a business rule name)",
      +  "type": "string"
      +}
    • addedInput schema / properties / queue
      Added value: +{
      +  "description": "Optional custom event queue name",
      +  "type": "string"
      +}
  2. First observedv1.0.2

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already disclose non-read-only, non-idempotent, non-destructive, open-world behavior, so the description's main added value is the SCRIPTING_ENABLED=true feature-flag requirement, which is genuinely useful pre-call context. It does not disclose what happens on duplicate names, whether registration takes effect immediately, or whether registrations can be undone — meaningful gaps for a non-idempotent mutation.

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 sentence with the action and target front-loaded and the prerequisite tucked into a short parenthetical. There is no filler, restatement of the title, or redundant explanation.

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?

For a five-parameter mutation with fully documented schema fields, the definition covers the core action and the feature-flag prerequisite adequately. However, with no output schema in place, an agent still cannot tell what registration returns (an id, a confirmation), nor how duplicate names are handled — both worth one sentence in a definition this terse.

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%, with per-field descriptions and inline examples for name, table, queue, fired_by, and description, so the schema carries the parameter burden. The tool description adds no parameter meaning of its own beyond the same implication of a name and a source table, which matches the baseline of 3.

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 pairs a specific verb ("Register") with a specific resource ("a new custom event in the event registry"), which is enough to separate it from the sibling reader tools such as list_event_registry and get_event_registry_entry. It does not explicitly name fire_event as the contrasting action, so the differentiation from that sibling is left implicit.

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 only implied: registration logically precedes firing an event, and the parenthetical states a gating prerequisite (SCRIPTING_ENABLED=true). The description never says when to choose this over fire_event or the registry-listing tools, nor what to do if the name already exists.

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

Deploy Server

Other Tools