Skip to main content
Glama

get_ai_agent

Read-only

Retrieve a ServiceNow AI agent definition by system ID, including its configuration, tools, versions, and execute ACLs.

Instructions

Get an AI agent definition with its config, tools, versions and execute ACLs

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>"
    },
    "name": "get_ai_agent"
  }
}

Input Schema

NameRequiredDescriptionDefault
sys_idYesSystem ID of the AI agent

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv4.9.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is known. The description adds value by disclosing the returned payload (config, tools, versions, execute ACLs), which matters since there is no output schema, but it says nothing about behavior on an unknown sys_id, permissions required to see ACLs, or payload size.

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 zero filler; the resource and the returned components are packed in without redundancy.

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?

For a one-parameter read-only fetch with no output schema, the description covers what the tool returns, which is the main missing structured information. Minor gaps remain around not-found behavior and access requirements to view execute ACLs.

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% and the single parameter sys_id is documented as "System ID of the AI agent", so the schema carries the semantics. The description adds no format, example, or lookup guidance beyond that, which is the expected baseline here.

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?

Names a specific verb and resource ("Get an AI agent definition") and enumerates what the definition comprises: config, tools, versions, execute ACLs. That distinguishes it reasonably well from list_ai_agents and get_ai_agent_execution, though it never explicitly states it fetches a single agent by ID versus a collection.

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: the singular "an AI agent definition" plus the required sys_id suggests single-record retrieval, in contrast to list_ai_agents. There is no explicit when-to-use/when-not statement and no mention of the execution or version siblings that could be confused with it.

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