Skip to main content
Glama
ThatDayneGuy

Autotask MCP Server

by ThatDayneGuy
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

autotask_get_ticket_attachment

Retrieve a ticket attachment from Autotask. Returns metadata by default, or base64 content when includeData is true. Large attachments are omitted to avoid exceeding limits.

Instructions

Get a ticket attachment. With includeData=false (default) returns metadata only — fast, suitable for browsing. With includeData=true returns the base64 binary content via the top-level /TicketAttachments/{id} endpoint (the child endpoint never populates data). The attachment is verified to belong to the given ticketId. Oversized binaries are stripped from the response with a dataOmittedReason field — Autotask attachments can be up to 3 MB, which is ~4 MB as base64 and may exceed the MCP client tool-result limit (~1 MB).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ticketIdYesThe ticket ID the attachment belongs to
includeDataNoSet true to fetch the base64-encoded file bytes. Default false returns metadata only.
attachmentIdYesThe attachment ID to retrieve
maxInlineBase64BytesNoCap on base64 string length before data is stripped (default 750_000, ~560 KB raw). Only relevant when includeData=true. Raise carefully — your MCP client may reject oversized tool results.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.18.0

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description fully discloses behavioral traits: two modes of operation, endpoint selection, ownership verification, and oversized binary handling with a dataOmittedReason field. This is comprehensive and transparent.

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?

The description is thorough but slightly lengthy. It is well-structured with the primary action upfront, and each sentence adds value. Minor trimming could improve conciseness, but the information density justifies the length.

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?

Given no output schema, the description adequately explains return value differences between the two modes and the oversized case. It does not detail the metadata structure, but for a single-attachment retrieval tool, this is sufficient.

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

Parameters5/5

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

All parameters are documented in the schema (100% coverage). The description adds significant meaning: for includeData it explains the endpoint behavior and default; for maxInlineBase64Bytes it provides context on defaults and risks. This goes beyond the schema.

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 clearly states it retrieves a ticket attachment, distinguishing between metadata-only and binary content retrieval via the includeData parameter. It references the endpoint behavior, making its function unambiguous relative to sibling tools like search or create.

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?

The description provides explicit guidance on when to use includeData=false vs true, and warns about oversized binaries. It implicitly differentiates from search_ticket_attachments by specifying retrieval by ID, but does not explicitly contrast with siblings.

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