Skip to main content
Glama

Start uploading a world archive

startWorldUpload

Only for an assistant that can send the user's file with HTTP PUT, such as a coding agent with a shell. Begins uploading a world archive (.zip, .tar.gz, .tgz; up to 4 GiB). Returns jobId, uploadId, key and parts (partNumber, url valid one hour): PUT each piece to its url, keep each ETag, then call completeWorldUpload. Refused while another upload or a backup export is still running.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "path": "<path>"
    },
    "name": "startWorldUpload"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyNo
pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare non-read-only, non-idempotent, closed-world. The description genuinely adds beyond them: it discloses the return fields (jobId, uploadId, key, parts), the one-hour URL validity, the ETag retention requirement, and the concurrency lock against other uploads/backup exports. However it omits what a failed or abandoned upload leaves behind and whether the world is replaced only at completion; still, the added behavioral detail is substantive.

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?

Three dense sentences, front-loaded with the eligibility constraint, then the return contract, then the precondition. Nothing is padding, though the parenthetical stacking (formats, part fields, URL lifetime, size cap) makes it cramped to parse at a glance.

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?

For a two-parameter nested-object tool with no output schema, the description covers the multipart protocol, the completion dependency, the return shape, and the concurrency precondition. The remaining gap is the absence of any mapping to the required serverId/path argument, without which an agent cannot actually construct the call from the description alone.

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

Parameters2/5

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

Schema coverage is reported at 0%, so the description must carry the load, but it never mentions the required path.serverId (the server to upload into) or the body fields fileName/fileSize/partCount. The only parameter-adjacent facts are the 4 GiB cap and the existence of parts; the 8 MiB part-size rule and how partCount is computed appear only in the schema.

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

Purpose4/5

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

Names a specific verb and resource ("Begins uploading a world archive") and constrains the artifact types (.zip, .tar.gz, .tgz). It is distinguishable from sibling upload starters only by the noun "world"; it never states that modpack or asset uploads are a different tool, so an agent must infer the boundary from the sibling names.

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?

Gives a strong eligibility gate ("Only for an assistant that can send the user's file with HTTP PUT, such as a coding agent with a shell") and a precondition ("Refused while another upload or a backup export is still running"), plus the follow-up step ("then call completeWorldUpload"). It stops short of naming alternatives such as completeWorldUpload/abortWorldUpload as fallbacks or distinguishing this from startAssetUpload/startModpackUpload, so not a 5.

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