Skip to main content
Glama

get_rest_message

Retrieve complete configuration details for a ServiceNow outbound REST Message, including all associated endpoints, using the REST Message's sys_id or name.

Instructions

Get full configuration of an outbound REST Message including its endpoints

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sys_id_or_nameYesREST Message sys_id or name
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states this is a 'Get' operation, implying it's likely read-only, but doesn't confirm if it requires specific permissions, has rate limits, returns paginated results, or what the output format looks like. For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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?

The description is a single, efficient sentence that front-loads the key information ('Get full configuration') without any wasted words. It's appropriately sized for a simple retrieval tool and earns its place by specifying the resource scope.

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 simple read operation with one well-documented parameter and no output schema, the description is minimally adequate. However, it lacks details on output format, error conditions, or behavioral traits that would be helpful given the absence of annotations. It meets basic needs but leaves room for improvement in context.

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?

The input schema has 100% description coverage, with the single parameter 'sys_id_or_name' clearly documented. The description doesn't add any additional semantic context beyond what the schema provides, such as examples or clarification on name uniqueness. Given the high schema coverage, the baseline score of 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 clearly states the action ('Get full configuration') and resource ('outbound REST Message including its endpoints'), making the purpose specific and understandable. It doesn't explicitly differentiate from sibling tools like 'list_rest_messages' or 'get_rest_message_functions', but the focus on full configuration of a specific message is reasonably distinct.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'list_rest_messages' for browsing or 'create_rest_message' for creation. There's no mention of prerequisites, context, or exclusions, leaving the agent to infer usage based on the tool name alone.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aartiq/servicenow-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server