Skip to main content
Glama
amanharshx
by amanharshx

dataset_upload_folder

Upload a local image folder as a zip to an Ultralytics dataset, queue ingestion, and report the queued job ID with current ingest status for follow-up.

Instructions

Upload a local image folder as a zip through the signed-upload flow for a dataset by slug, owner/slug, or a ul://owner/datasets/slug URI. Defaults conflictPolicy to skip (the platform default is undocumented). Reports the queued job id with the dataset's current ingest status; use datasets_get to follow up.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
datasetYesDataset ref by slug, owner/slug, or a ul://owner/datasets/slug URI.
folder_pathYesLocal path to image folder.
targetSplitNoTarget split for new images. Rejected if the folder itself has train/val/test subdirectories; use one or the other, not both.
conflictPolicyNoConflict policy, e.g. "skip" (default), "keep_both", or "replace". Server-validated.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.15
    • addedInput schema / additionalProperties
      Added value: +false
  2. Changed3 schema fields changedv0.1.13
    • changedInput schema / properties / conflictPolicy / description
      Previous value: -"Conflict policy \"skip\" (default), \"keep_both\", or \"replace\"."New value: +"Conflict policy, e.g. \"skip\" (default), \"keep_both\", or \"replace\". Server-validated."
    • changedInput schema / properties / dataset / description
      Previous value: -"Dataset ref by slug, owner/slug, or ul:// URI."New value: +"Dataset ref by slug, owner/slug, or a ul://owner/datasets/slug URI."
    • addedInput schema / properties / targetSplit / description
      Added value: +"Target split for new images. Rejected if the folder itself has train/val/test subdirectories; use one or the other, not both."
  3. Changed2 schema fields changedv0.1.12
    • addedInput schema / properties / conflictPolicy
      Added value: +{
      +  "description": "Conflict policy \"skip\" (default), \"keep_both\", or \"replace\".",
      +  "type": "string"
      +}
    • changedInput schema / properties / dataset / description
      Previous value: -"Dataset ref by id, slug, username/slug, or ul:// URI."New value: +"Dataset ref by slug, owner/slug, or ul:// URI."
  4. Addedv0.1.6

TDQS

A4.1/5.0
Behavior4/5

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

Annotations cover the write/safety profile (readOnly=false, idempotent=false, destructive=false), so the bar is lower, but the description still adds real value: the async 'signed-upload flow', the default conflict policy with a note that the platform default is undocumented, and the fact that it returns a queued job id plus ingest status. It does not detail permission requirements or failure modes.

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?

Two dense but front-loaded sentences; the purpose leads and the follow-up guidance trails. Minor parentheticals ('the platform default is undocumented') are slightly chatty but earn their place as a caveat.

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 write tool with no output schema, the description covers the essentials: input formats, default policy, async job semantics, and a follow-up tool. Remaining gaps (permissions, idempotency implications, error behavior) are modest given the annotation coverage.

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 description coverage is 100%, so the baseline is 3 and the schema already documents all four parameters including the conflictPolicy default and targetSplit constraint. The description only restates the dataset ref formats and echoes the conflictPolicy default, adding little beyond the schema.

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+resource+scope: 'Upload a local image folder as a zip ... for a dataset.' The 'image folder as a zip' phrasing cleanly separates it from the file and video upload siblings, and it enumerates the accepted dataset reference formats. An agent knows exactly what this tool does without opening the schema.

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 clear operational context ('signed-upload flow', default conflictPolicy of skip) and an explicit follow-up path ('use datasets_get to follow up'). It does not, however, explicitly say when to pick this over dataset_upload_file or dataset_upload_video, leaving that choice to the reader.

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