Skip to main content
Glama

Create IT Glue Attachment

itglue_create_attachment

Attach a file (PDF, image, config export) to an IT Glue record such as a document or flexible asset, using base64, URL, file path, or upload ID. The file appears in the record's Attachments panel.

Instructions

Attach a file (PDF, image, config export, …) to a record (document, flexible asset, configuration, etc.). The file appears in the record's Attachments side panel — it is NOT shown inside a document's body. To place a picture inside a document (inline in a Text/Step section or in a Gallery), use itglue_create_document_image instead. Provide exactly one source: content_base64 (small files only), url (the server fetches it), file_path (local stdio runs only), or upload_id (a file the client PUT via itglue_request_upload — use this for anything on the client's disk). Give file_name with an extension (e.g. network-diagram.pdf) so IT Glue detects the type; it is inferred from url/file_path/upload when omitted. Max 25 MB.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoURL the server fetches and base64-encodes
file_nameNoDisplay file name with extension; inferred from url/file_path if omitted
file_pathNoLocal filesystem path to read (stdio transport only)
upload_idNoID from itglue_request_upload after the client has PUT the file to the returned URL — the server reads the bytes itself
resource_idYesThe parent record ID
resource_typeYesThe record type to attach to
content_base64NoBase64-encoded file bytes (a leading data: URI prefix is stripped) — small files only
response_formatNoOutput format: human-readable markdown (default) or structured JSONmarkdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.6.0
    • changedInput schema / properties / content_base64 / description
      Previous value: -"Base64-encoded file bytes (a leading data: URI prefix is stripped)"New value: +"Base64-encoded file bytes (a leading data: URI prefix is stripped) — small files only"
    • addedInput schema / properties / upload_id
      Added value: +{
      +  "description": "ID from itglue_request_upload after the client has PUT the file to the returned URL — the server reads the bytes itself",
      +  "type": "string"
      +}
  2. First observedv0.3.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations indicate this is a write operation (readOnlyHint=false) and not idempotent, so the description doesn't need to restate that. It adds useful behavioral context: the file is attached to the side panel, not shown inline, and the 25 MB limit and the specific behavior of each source (e.g., server fetches URL, server reads upload_id bytes) go beyond the annotations. Minor gap: it doesn't state what happens on failure (e.g., whether the attachment is created if the upload_id is invalid), but this is acceptable.

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 concise, fitting in a few sentences with no filler. Key information (purpose, distinction from sibling, source options, file_name guidance, size limit) is front-loaded, making it easy for an agent to quickly grasp the essentials without scanning for details.

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?

Given the tool's complexity (8 parameters, multiple source options), the description provides comprehensive guidance: it covers all source alternatives, file naming, size limits, and how to handle client-side files via upload_id. Since there is no output schema, the agent might not know the return format, but the response_format parameter is documented in the schema with its enum, and the description doesn't need to restate it. Overall, no critical information is missing for correct invocation.

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 the schema already documents all parameters with descriptions. However, the description adds value by clarifying the use cases and constraints for each source parameter (e.g., 'small files only' for content_base64, 'stdio runs only' for file_path), which is not fully captured in the schema descriptions. This elevates the score above the baseline 3 for high coverage, though it's not a major addition.

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 the tool's function: attaching a file to a record, and explicitly distinguishes it from itglue_create_document_image for inline images. It also enumerates the supported record types, making its scope precise and easily distinguishable from siblings.

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

Usage Guidelines5/5

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

The description provides explicit when-to-use guidance, contrasting with the alternative for inline images, and details the conditions for each source parameter (content_base64 for small files, url for server fetch, file_path for local runs, upload_id for client disk files). It also instructs on the file_name extension and size limit, ensuring correct invocation.

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