Skip to main content
Glama

sn_get

Read-onlyIdempotent

Retrieves exactly one policy-approved ServiceNow record using an exact sys_id or approved table-specific identifier; returns not_found or conflict when no or multiple matches occur.

Instructions

Get exactly one record from a policy-approved ServiceNow table by a strict 32-hex sys_id or an approved table-specific human-readable identifier. Identifier resolution is exact and bounded: no match returns not_found and multiple matches return conflict. Explicit fields win; otherwise concise uses safe defaults and detailed returns all policy-approved readable fields.

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

Input Schema

NameRequiredDescriptionDefault
tableYesPolicy-approved ServiceNow table name
fieldsNoComma-separated approved fields to return. Omit for safe defaults; pass "all" for every approved readable field.
sys_idNoExact 32-hex ServiceNow sys_id; mutually exclusive with identifier
profileYesConfigured ServiceNow profile name (required; no default fallback).
identifierNoApproved table-specific human identifier as {field,value}; mutually exclusive with sys_id
display_valueNoDisplay values mode: true, false, or all
force_recacheNoFor metadata tables, bypass the per-instance metadata cache and refresh from ServiceNow.
response_formatNoVerbosity when fields is omitted. "concise" uses safe defaults; "detailed" uses every approved readable field. Ignored when fields is provided.concise
max_response_bytesNoFinal response byte budget (default 100000, min 1000, max 1000000). Long field values are shortened without mutating upstream data. Cache and timing metadata (under 100 bytes) are not counted.

Output Schema

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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.3.0
    • changedInput schema / properties / max_response_bytes / description
      Previous value: -"Final response byte budget (default 100000, min 1000, max 1000000). Long field values are shortened without mutating upstream data."New value: +"Final response byte budget (default 100000, min 1000, max 1000000). Long field values are shortened without mutating upstream data. Cache and timing metadata (under 100 bytes) are not counted."
    • addedOutput schema / properties / metadata / properties / cache
      Added value: +{
      +  "enum": [
      +    "hit",
      +    "miss",
      +    "bypass",
      +    "mixed"
      +  ],
      +  "type": "string"
      +}
    • addedOutput schema / properties / metadata / properties / timing
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "total_ms": {
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "upstream_ms": {
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "watermark_ms": {
      +      "minimum": 0,
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "total_ms",
      +    "upstream_ms",
      +    "watermark_ms"
      +  ],
      +  "type": "object"
      +}
  2. Changed13 schema fields changedv2.2.0
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / display_value / enum
      Added value: +[
      +  "true",
      +  "false",
      +  "all"
      +]
    • changedInput schema / properties / fields / description
      Previous value: -"Comma-separated list of fields to return"New value: +"Comma-separated approved fields to return. Omit for safe defaults; pass \"all\" for every approved readable field."
    • addedInput schema / properties / force_recache
      Added value: +{
      +  "default": false,
      +  "description": "For metadata tables, bypass the per-instance metadata cache and refresh from ServiceNow.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / identifier
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Approved table-specific human identifier as {field,value}; mutually exclusive with sys_id",
      +  "properties": {
      +    "field": {
      +      "pattern": "^[a-z][a-z0-9_]{0,79}$",
      +      "type": "string"
      +    },
      +    "value": {
      +      "maxLength": 256,
      +      "minLength": 1,
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "field",
      +    "value"
      +  ],
      +  "type": "object"
      +}
    • addedInput schema / properties / max_response_bytes
      Added value: +{
      +  "default": 100000,
      +  "description": "Final response byte budget (default 100000, min 1000, max 1000000). Long field values are shortened without mutating upstream data.",
      +  "maximum": 1000000,
      +  "minimum": 1000,
      +  "type": "integer"
      +}
    • addedInput schema / properties / profile
      Added value: +{
      +  "description": "Configured ServiceNow profile name (required; no default fallback).",
      +  "maxLength": 128,
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / response_format
      Added value: +{
      +  "default": "concise",
      +  "description": "Verbosity when fields is omitted. \"concise\" uses safe defaults; \"detailed\" uses every approved readable field. Ignored when fields is provided.",
      +  "enum": [
      +    "concise",
      +    "detailed"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / sys_id / description
      Previous value: -"The sys_id of the record to retrieve"New value: +"Exact 32-hex ServiceNow sys_id; mutually exclusive with identifier"
    • addedInput schema / properties / sys_id / pattern
      Added value: +"^[0-9a-f]{32}$"
    • changedInput schema / properties / table / description
      Previous value: -"ServiceNow table name (e.g. incident)"New value: +"Policy-approved ServiceNow table name"
    • changedInput schema / required
      Previous value: -[
      -  "table",
      -  "sys_id"
      -]New value: +[
      +  "table",
      +  "profile"
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "hint": {
      +          "type": "string"
      +        },
      +        "record": {
      +          "additionalProperties": {},
      +          "propertyNames": {
      +            "type": "string"
      +          },
      +          "type": "object"
      +        }
      +      },
      +      "required": [
      +        "record"
      +      ],
      +      "type": "object"
      +    },
      +    "metadata": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "kind": {
      +          "enum": [
      +            "single",
      +            "collection",
      +            "operation"
      +          ],
      +          "type": "string"
      +        },
      +        "limits": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "max_bytes": {
      +              "maximum": 14680064,
      +              "minimum": 1000,
      +              "type": "integer"
      +            },
      +            "max_records": {
      +              "exclusiveMinimum": 0,
      +              "maximum": 9007199254740991,
      +              "type": "integer"
      +            }
      +          },
      +          "required": [
      +            "max_records",
      +            "max_bytes"
      +          ],
      +          "type": "object"
      +        },
      +        "pagination": {
      +          "anyOf": [
      +            {
      +              "additionalProperties": false,
      +              "properties": {
      +                "mode": {
      +                  "const": "none",
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "mode"
      +              ],
      +              "type": "object"
      +            },
      +            {
      +              "additionalProperties": false,
      +              "properties": {
      +                "has_more": {
      +                  "type": "boolean"
      +                },
      +                "limit": {
      +                  "exclusiveMinimum": 0,
      +                  "maximum": 9007199254740991,
      +                  "type": "integer"
      +                },
      +                "mode": {
      +                  "const": "offset",
      +                  "type": "string"
      +                },
      +                "next_offset": {
      +                  "maximum": 9007199254740991,
      +                  "minimum": 0,
      +                  "type": "integer"
      +                },
      +                "offset": {
      +                  "maximum": 9007199254740991,
      +                  "minimum": 0,
      +                  "type": "integer"
      +                },
      +                "order_by": {
      +                  "items": {
      +                    "minLength": 1,
      +                    "type": "string"
      +                  },
      +                  "maxItems": 8,
      +                  "minItems": 1,
      +                  "type": "array"
      +                },
      +                "recovery": {
      +                  "const": "adjust_request_and_retry_same_offset",
      +                  "type": "string"
      +                },
      +                "returned": {
      +                  "maximum": 9007199254740991,
      +                  "minimum": 0,
      +                  "type": "integer"
      +                }
      +              },
      +              "required": [
      +                "mode",
      +                "limit",
      +                "offset",
      +                "returned",
      +                "has_more",
      +                "order_by"
      +              ],
      +              "type": "object"
      +            }
      +          ]
      +        },
      +        "record_count": {
      +          "maximum": 9007199254740991,
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "truncation": {
      +          "additionalProperties": false,
      +          "properties": {
      +            "dropped_records": {
      +              "maximum": 9007199254740991,
      +              "minimum": 0,
      +              "type": "integer"
      +            },
      +            "reason": {
      +              "enum": [
      +                "record_limit",
      +                "byte_limit"
      +              ],
      +              "type": "string"
      +            },
      +            "truncated": {
      +              "type": "boolean"
      +            }
      +          },
      +          "required": [
      +            "truncated"
      +          ],
      +          "type": "object"
      +        }
      +      },
      +      "required": [
      +        "kind",
      +        "record_count",
      +        "limits",
      +        "pagination",
      +        "truncation"
      +      ],
      +      "type": "object"
      +    },
      +    "profile": {
      +      "description": "Configured ServiceNow profile name (required; no default fallback).",
      +      "maxLength": 128,
      +      "minLength": 1,
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "data",
      +    "metadata",
      +    "profile"
      +  ],
      +  "type": "object"
      +}
  3. First observedv1.0.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint. Beyond those, the description adds real behavioral detail: zero matches yields not_found, multiple matches yield conflict, and byte-budget truncation shortens long values without mutating upstream data. Not fully exhaustive (no mention of auth/profile preconditions), but materially additive.

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?

Three tight sentences, front-loaded with purpose then resolution semantics then field-selection precedence; no filler. Slightly dense with terms like 'policy-approved' repeated, but nothing is wasted.

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, so return payload structure needn't be described, and the description still covers the two notable error outcomes. For a 9-parameter read tool with nested identifier object, this leaves only minor gaps such as profile/auth requirements.

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 the schema already documents all nine parameters, including the fields-vs-response_format precedence. The description restates that precedence ('Explicit fields win; otherwise concise uses safe defaults and detailed returns all') but adds no syntax or format detail the schema lacks. Baseline 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 exactly one record from a policy-approved ServiceNow table') plus the two accepted lookup keys (32-hex sys_id or table-specific identifier). The 'exactly one record' wording implicitly separates it from list-style siblings like sn_query, though no sibling is named 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?

It conveys how to select a record (sys_id vs identifier) and the exact/bounded resolution rule, but gives no explicit guidance on when to prefer this tool over sn_query or sn_aggregate, nor any prerequisites beyond 'policy-approved' tables. Usage is implied rather than stated.

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