Skip to main content
Glama

file_upload_request

Get a one-time uploader script to push a local file into a shared file.

For large local HTML/Markdown files that don't fit inline in file_create/file_update. PDFs and other binaries are Storage objects (storage_upload_request); this path is UTF-8 documents only. Returns upload_url, upload_token, an expires_in_seconds TTL, and a self-deleting Python script. Save the script to disk and run python3 upload.py /path/to/file; it reads the file, POSTs it to the server with the one-time token, prints the resulting file id (and public URL if publish=true), and deletes itself on success. The token is single-use and expires in ~10 min.

Update mode: pass file_id to append the uploaded body as a new version to an existing shared file (the title is ignored; the existing file's title/slug/share_token are preserved, and the bucket mirror is re-published to the new version when the file is already published). This is the supported way to push a new version of a large file.

Input Schema

NameRequiredDescriptionDefault
agentNoOverride agent identity
titleYesFile title (used only when creating a new file; ignored in update mode)
file_idNoExisting file UUID to append a new version to (update mode). Omit to create a new file.
publishNoIf true, the file is published immediately (returns public URLs). In update mode this is idempotent if already published.
work_idNoAttach the uploaded file to this work item UUID
filenameNoOptional filename (used for format sniffing and as the script's default path)
project_idNoAttach the uploaded file to this project UUID (kind=artifact)
content_formatNo'html', 'markdown', 'diagram' (teamshared.diagram/v1 JSON/YAML), 'sheet' (teamshared.sheet/v1 JSON/YAML), or 'auto' (sniff from the file extension; *.diagram.yaml/json, *.sheet.json/yaml)auto
upload_base_urlNoOptional server origin (e.g. https://teamshared.com). Defaults to settings.public_url.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / content_format / description
      Previous value: -"'html', 'markdown', 'diagram' (teamshared.diagram/v1 JSON/YAML), or 'auto' (sniff from the file extension; *.diagram.yaml/json)"New value: +"'html', 'markdown', 'diagram' (teamshared.diagram/v1 JSON/YAML), 'sheet' (teamshared.sheet/v1 JSON/YAML), or 'auto' (sniff from the file extension; *.diagram.yaml/json, *.sheet.json/yaml)"
  2. Changed2 schema fields changed
    • changedInput schema / properties / content_format / description
      Previous value: -"'html', 'markdown', or 'auto' (sniff from the file extension)"New value: +"'html', 'markdown', 'diagram' (teamshared.diagram/v1 JSON/YAML), or 'auto' (sniff from the file extension; *.diagram.yaml/json)"
    • addedInput schema / properties / project_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Attach the uploaded file to this project UUID (kind=artifact)"
      +}
  3. Changed1 schema field changed
    • addedInput schema / properties / work_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Attach the uploaded file to this work item UUID"
      +}
  4. First observed

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations, the description carries the full behavioral burden and does it well: single-use token, ~10 minute expiry, returned artifacts (upload_url, upload_token, expires_in_seconds, self-deleting script), exact invocation pattern, and that the script prints the file id. Update mode is further qualified with what is preserved (title/slug/share_token) and that the bucket mirror is re-published when already published.

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 purpose in sentence one, then a scoping paragraph, then the return/invocation flow, then a bolded section for update mode — a clean progression. A few clauses (e.g. restating the script's delete-on-success behavior alongside the TTL) are slightly redundant, but nothing is padding.

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?

For a 9-parameter tool with no annotations, the description supplies the operational contract an agent actually needs: what to do with the returned script, how the token is consumed, what happens on update versus create, and how publishing interacts with versioning. An output schema exists, yet the description still front-loads the key return fields so the agent knows what to expect before calling.

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 coverage is 100%, so the baseline is 3, but the description adds real semantics on top: it clarifies that title is ignored in update mode, that file_id switches the whole tool into version-append mode, and that publish=true yields a public URL in the script output. It does not explain content_format options (diagram/sheet) or the work_id/project_id attachment semantics, which remain schema-only.

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 first sentence names a specific verb and resource ('Get a one-time uploader script to push a local file into a shared file') and the following lines immediately scope it against siblings: inline content goes to file_create/file_update, binaries go to storage_upload_request. An agent can place this tool precisely in the file-handling family without opening any schema.

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?

Explicit when-to-use is given ('For large local HTML/Markdown files that don't fit inline'), plus two named alternatives for the cases this tool does not cover. It also documents update mode ('pass file_id to append... This is the supported way to push a new version of a large file'), so both create and update scenarios are routed correctly.

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.