Skip to main content
Glama

Playbook

by com.playbook
OverviewDiscussionsAdmin

Upload from URL

upload_from_url

Upload a single asset to a Playbook board by giving Playbook a public URL to fetch. Returns immediately with a skeleton asset; the byte fetch runs asynchronously in the background. Requires a token with the write scope. Playbook fetches the URL itself, anonymously — a link behind a login or a signed URL that has expired will not work here, and neither will a file that exists only on someone's machine. For those, use share_board with enable_uploads. It returns a link a person can drop files on without signing in, and whatever they add lands on that board for you to collect with list_assets. It needs a live human and it shows the board's existing contents to anyone holding the link, so reach for it only once no fetchable URL is available. The fetch runs to a time budget (five minutes of streaming), so a source that is very large or very slow fails with "Source URL too large to fetch; upload manually" — when that happens, send the bytes yourself with create_upload_url rather than retrying. Tip: validate collection_token with get_board first — an unknown token silently falls back to an anonymous default board.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uriYesPublic URL of the file to ingest
tagsNoManual tags to apply
titleNoOverride the title. Defaults to the filename in the URL. Not derived when as_link is true — Playbook titles those from the linked page's own metadata.
statusNoStatus label to set
as_linkNoIf true, store as a bare link instead of fetching bytes (default false)
descriptionNoOptional description
ai_generatedNoMark the asset as produced by an AI tool. Set it at creation rather than by a later update. Through these tools it is a marker and nothing else; on Playbook's REST presigned-upload endpoints the same flag additionally suppresses automatic duplicate merging and grouping.
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.
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: -[
-  "uri",
-  "context"
-]New value: +[
+  "uri"
+]
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: returns a skeleton asset immediately while the fetch runs async, requires the `write` scope, fetches anonymously, has a five-minute streaming budget with a specific failure string, and silently falls back to an anonymous board on an unknown token. None of this is inferable from readOnlyHint/openWorldHint/idempotentHint.

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, then conditions and fallbacks in a logical order. It is long and the share_board detour runs several clauses, but nearly every sentence carries operational weight (auth, async, timeout, fallback).

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 an async mutation tool with 10 params and no output schema, it covers return timing (skeleton asset), lifecycle, auth scope, failure modes, and error recovery paths. An agent has everything needed to call it or route elsewhere correctly.

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. The description adds real value on the highest-risk parameter by cautioning that `collection_token` silently defaults to an anonymous board and should be validated via get_board first, slightly exceeding what the schema text conveys.

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, and mechanism: 'Upload a single asset to a Playbook board by giving Playbook a public URL to fetch.' The word 'single' and 'fetch' distinguish it from upload_from_urls (plural) and the presigned create_upload_url path 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?

Explicitly names the when-not conditions (login-gated links, expired signed URLs, local-only files) and routes to named alternatives: share_board with enable_uploads for human drop, create_upload_url when the fetch fails. It even frames share_board's downside (needs a live human, leaks existing contents) to gate its use.

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