Skip to main content
Glama
servicenow-mcp

servicenow-mcp

sn_attachment_download

Download a ServiceNow attachment by sys_id and save it to a local path; return only the file path and size, refusing to overwrite unless explicitly enabled.

Instructions

Download one attachment from ServiceNow and save it to a local file. Returns the path and size only, never the file contents. Refuses to replace an existing file unless overwrite is 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": {
      "sys_id": "<sys_id>",
      "save_to": "<save_to>"
    },
    "name": "sn_attachment_download"
  }
}

Input Schema

NameRequiredDescriptionDefault
sys_idYesThe sys_id of the attachment (from sn_attachment_list): 32 hex characters.
save_toYesAbsolute local path to save the file to. The folder must already exist.
overwriteNoSet to true to replace a file that already exists at save_to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Beyond the sparse annotations, it discloses the output contract ('returns the path and size only, never the file contents') and the overwrite guard ('refuses to replace an existing file unless overwrite is true'), which matters because destructiveHint is false but overwrite can still clobber a file. It stops short of stating permission requirements, size limits, or what errors look like.

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 action and side effect, followed by the return contract and the safety condition. Nothing is redundant and no sentence could be dropped without losing information.

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 three-parameter tool with full schema coverage and no output schema, the description substitutes well by stating exactly what is returned and how overwrite prevents data loss. It omits auth or permission requirements and any error/limit behavior, which would matter for an attachment download.

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 every parameter is already documented, including the sys_id format, the absolute-path requirement, and the overwrite default. The description adds no syntax or format meaning beyond what the schema already carries, so baseline 3 applies.

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 names a specific verb and resource ('Download one attachment from ServiceNow') plus the concrete side effect ('save it to a local file'), which cleanly separates it from siblings like sn_attachment_list, sn_attachment_upload, and sn_attachment_delete.

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 description makes clear this is the retrieval path for a single attachment, and the sys_id parameter points to sn_attachment_list as the source. It never states when to prefer this over another tool or what to do for multiple attachments, leaving the caller to infer the workflow.

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