Skip to main content
Glama
servicenow-mcp

servicenow-mcp

sn_instance_info

Read-only

Check the connected ServiceNow instance, signed-in user, build tag, and write mode; use it as a first call to verify server connectivity.

Instructions

Show which ServiceNow instance this server talks to, who is signed in, the instance build tag, and whether write tools are allowed. write_mode is off, plan (writes only through sn_apply_plan) or all. A good first call to check that the connection works.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sn_instance_info"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, but the description adds real behavioral context beyond them: what identity/instance data comes back and the three write_mode values, including the important rule that 'plan' mode restricts writes to sn_apply_plan. It stops short of describing failure behavior when the connection is broken, which would complete the picture.

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?

Three short sentences, front-loaded with the returned fields, then the write_mode enumeration, then the recommended first-call use. Every sentence carries distinct information with no padding.

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

Completeness5/5

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

There is no output schema, so the description must describe return values itself, and it does so exhaustively (instance, user, build tag, write mode). Combined with the zero-parameter schema and readOnly annotation, an agent has everything needed to call and interpret this tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline is 4. The write_mode mention refers to returned state rather than an input, so no additional parameter semantics are needed.

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?

The description uses a specific verb (Show) and enumerates exactly what it returns: which instance the server talks to, who is signed in, the build tag, and whether write tools are allowed. This is clearly distinguishable from the sibling sn_table_* and sn_plan_* tools, which operate on records or plans rather than reporting connection status.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit situational guidance ('A good first call to check that the connection works') and explains write_mode states so the agent knows when writes are permitted vs restricted to sn_apply_plan. It does not name an alternative diagnostic tool or state exclusions, so it falls short of a full 5.

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