Skip to main content
Glama

Confirm an upload and get its attachment path

attach_file

Confirm an upload and get its attachment path.

Step 3 of 3: after the PUT succeeded. Returns the attachment path to put in add_comment attachments or in an issue body. Show an image inline with ![file name](path) in the comment or issue body (never base64); link other files with [file name](path). A path with a space or a parenthesis (screenshot names have them) must be written ![file name](<path>), else it shows as plain text.

Input Schema

NameRequiredDescriptionDefault
reasonNoSpec D144: why you make this change (≤ 200 characters). Optional, but give it when you act as an agent account — it is shown in the agent's run log ("moved KJ-12 To Do → In Progress because <reason>"). board-mcp records it in `agent.run`; board-core / board-files accept it and ignore it (it never changes the file, the version or the history).
upload_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / reason
      Added value: +{
      +  "description": "Spec D144: why you make this change (≤ 200 characters). Optional, but give it when you act as an agent account — it is shown in the agent's run log (\"moved KJ-12 To Do → In Progress because <reason>\"). board-mcp records it in `agent.run`; board-core / board-files accept it and ignore it (it never changes the file, the version or the history).",
      +  "maxLength": 200,
      +  "type": "string"
      +}
  2. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare the write-ish profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false). The description adds the sequencing precondition and what the return value is for, but says nothing about retry behavior despite idempotentHint=false, nor what happens to the upload if this confirm step is never called.

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?

Front-loaded with the core action, then the sequencing, then the output usage rules. The opening sentence is a verbatim repeat of the title, which is minor waste; the markdown escaping rule is dense but genuinely necessary because screenshot filenames break naive markdown links.

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?

No output schema exists, and the description does the required work by stating that it returns the attachment `path` and exactly how to embed that path. It leaves failure modes (expired upload_id, failed confirm) undiscussed, but an agent has enough to call it correctly.

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 50%: `reason` is richly documented in the schema, but `upload_id` has no description anywhere. The 'after the PUT succeeded' framing indirectly tells the agent where upload_id originates, but the description never mentions the parameter or its format.

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?

States a specific verb and resource (confirm an upload, produce an attachment path) and immediately locates it in the workflow as 'Step 3 of 3: after the PUT succeeded'. This clearly distinguishes it from request_upload (which starts the flow) and from list_attachments/get_download_url.

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?

Explicit precondition ('after the PUT succeeded') and explicit downstream usage: put the path in add_comment `attachments` or an issue body. It does not name a when-not case or an alternative sibling (e.g. get_download_url for reading an existing attachment), so it stops short of the top band.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources