Skip to main content
Glama

xero_upload_attachment

DestructiveIdempotent

Uploads a file attachment to a specified Xero record (e.g., invoice, quote) using the authenticated connector account.

Instructions

Xero connector operation upload_attachment (platform tool xero.upload_attachment).

Routes only through the exact project/account governed connector authority.

Args: arguments: JSON string of arguments for the connector operation. project_id: Authenticated Project UUID. project_ref: Exact project correlation reference. connector_account_ref: Project-bound connector account alias. idempotency_key: Stable business-action identity. effect: Claimed read or write effect; Spring verifies it. approval_ref: Approved platform task UUID when resuming a write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
effectNo
argumentsNo{}
project_idNo
project_refNo
approval_refNo
idempotency_keyNo
connector_account_refNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.1.1
    • addedInput schema / properties / approval_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Approval Ref"
      +}
    • addedInput schema / properties / connector_account_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Connector Account Ref"
      +}
    • addedInput schema / properties / effect
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Effect"
      +}
    • addedInput schema / properties / idempotency_key
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Idempotency Key"
      +}
    • addedInput schema / properties / project_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Project Id"
      +}
    • addedInput schema / properties / project_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Project Ref"
      +}
  2. First observedv0.1.0

TDQS

B3.2/5.0
Behavior4/5

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

The description adds meaningful behavioral context beyond the annotations: `effect` is a self-claimed read/write flag that Spring verifies, `approval_ref` is required when resuming writes, `idempotency_key` provides stable business-action identity, and routing is confined to a governed connector authority. These details give concrete meaning to the destructiveHint/idempotentHint annotations. Not a 5 because it never discloses what the upload actually mutates or what side effects follow a successful write.

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?

Compact and well-organized: a two-sentence header carries the operation identity and the critical governance constraint up front, followed by a tight aligned Args list. Each parameter line is short and consistent, with no filler. Slightly formulaic in the autogenerated style, but every line earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having an output schema and rich annotations, the description omits the operational core: it never explains what an attachment upload entails (target entity type, how the file/content is identified or transmitted) nor what shape the `arguments` JSON must take. With 7 parameters, 0 required, and the primary payload opaque, an agent cannot reliably construct a valid call from this definition alone.

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

Parameters4/5

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

Schema description coverage is 0%, and the Args block compensates by glossing all 7 parameters — distinguishing project_id from project_ref, explaining connector_account_ref's alias role, and clarifying approval_ref's write-resumption purpose. The weakness is `arguments`, described only as "JSON string of arguments for the connector operation," which is circular and gives the agent no information about the actual Xero upload payload.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening line "Xero connector operation `upload_attachment`" largely restates the tool name rather than explaining its function — no sentence actually says "uploads an attachment to a Xero record." It gains a point from the name's self-descriptiveness and the routing sentence, but the description never articulates what the operation does in domain terms.

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 only usage signal is the routing constraint "Routes only through the exact project/account governed connector authority," which tells the agent when it may not be used but not when to choose it over alternatives. Among dozens of sibling Xero tools (xero_upload_file, xero_api_request, xero_get_attachment), nothing distinguishes when to pick this one for attachment uploading, nor does it warn against using raw xero_api_request instead.

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