Skip to main content
Glama

Playbook

by com.playbook
OverviewDiscussionsAdmin

Finish upload

finish_upload

Step 2 of 2: turn bytes you have already sent to storage into a Playbook asset. Call it only after every step returned by create_upload_url has succeeded — this call does not transfer anything, it records what landed. Pass the signed_gcs_id from create_upload_url unchanged. If a step failed, do NOT call this; start over with a fresh create_upload_url.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sizeNoByte size, as passed to create_upload_url
titleNoAsset title. Pass the same filename you gave create_upload_url — it is NOT remembered between the two calls, and omitting it creates an untitled asset.
widthNoPixel width, if known. Do not guess.
heightNoPixel height, if known. Do not guess.
media_typeYesMIME type of the stored file. Required, and it must be the SAME value you gave when you asked for the upload address — nothing is carried between the two calls, so a different value here labels the asset as something the stored bytes are not.
descriptionNoOptional description
ai_generatedNoMark the asset as produced by an AI tool. On this upload path the flag does more than label it: it also suppresses automatic duplicate merging and grouping, which matters when you are pushing many variants of one image. It only has that effect when set HERE, at creation — setting it later records the marker but cannot un-merge anything.
organizationNoWorkspace slug, as returned by list_organizations. Omit it when the account has a single workspace — it is then resolved from your token. Pass it only when the account has several, or when you mean a workspace other than the obvious one.
signed_gcs_idYesThe value create_upload_url returned. Pass it back exactly, it is signed.
ai_agent_payloadNoFree-form JSON metadata stored with the asset — for example generation settings such as model and seed, or a source job id. Playbook never interprets it. Max 4096 BYTES of serialised JSON; anything larger is REJECTED, never truncated. A write REPLACES the whole object. Readable per asset (get_asset, or list/search with get_ai_payload=true) but NOT searchable or filterable.
collection_tokenNoDestination board token. If omitted or unknown, Playbook silently routes to a default anonymous board — call get_board first to validate.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / ai_agent_payload / description
      Previous value: -"Your own scratch space on this asset — prompt, model, seed, source job id, anything you need to recognise it in a later session. Playbook never interprets it. Max 4096 BYTES of serialised JSON; anything larger is REJECTED, never truncated. A write REPLACES the whole object. Readable per asset (get_asset, or list/search with get_ai_payload=true) but NOT searchable or filterable."New value: +"Free-form JSON metadata stored with the asset — for example generation settings such as model and seed, or a source job id. Playbook never interprets it. Max 4096 BYTES of serialised JSON; anything larger is REJECTED, never truncated. A write REPLACES the whole object. Readable per asset (get_asset, or list/search with get_ai_payload=true) but NOT searchable or filterable."
    • removedInput schema / properties / context
      Removed value: -{
-  "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "signed_gcs_id",
-  "media_type",
-  "context"
-]New value: +[
+  "signed_gcs_id",
+  "media_type"
+]
  2. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and idempotentHint=false, so the safety profile is covered. The description adds genuinely useful context beyond that: this call 'does not transfer anything, it records what landed', which corrects the likely assumption that finish_upload moves bytes, and it implies the retry semantics by requiring a fresh create_upload_url on failure. It stops short of stating explicitly what happens to a partially-recorded asset.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three sentences, front-loaded with the workflow position and purpose, then the precondition, then the failure exclusion. Every sentence earns its place and nothing is repeated.

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 non-idempotent mutation with 11 params, a nested object and no output schema, the description supplies the crucial orchestration context (two-step flow, ordering precondition, failure handling) that the schema cannot express. It is nearly complete; the only thin patch is what the caller gets back or how to confirm the asset landed, which is arguably outside description scope given the sibling get_asset exists.

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 all 11 parameters are already documented in-schema, including the signed_gcs_id and media_type 'pass it back unchanged' constraints. The description re-states the signed_gcs_id rule but adds no syntax or format detail the schema lacks. Baseline 3 applies when the schema carries the load.

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 ('turn bytes you have already sent to storage into a Playbook asset') and frames itself as 'Step 2 of 2', which cleanly distinguishes it from the sibling create_upload_url that precedes it. An agent can place it in the upload workflow 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?

Gives explicit when-to-use ('only after every step returned by create_upload_url has succeeded') and an explicit when-NOT-to, with the alternative action spelled out ('If a step failed, do NOT call this; start over with a fresh create_upload_url'). Nothing is left to inference.

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

All Playbook toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources