Skip to main content
Glama

Update asset

update_asset
DestructiveIdempotent

Update an asset's editable metadata: title, description, tags (replaces existing), status, custom field values, or move it to a different board. Only the fields you pass are changed — omit a field to leave it as-is. fields is where custom field VALUES are set; call list_custom_fields first for the exact spelling.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagsNoFull set of manual tags to apply (replaces existing)
titleNoNew title
tokenYesAsset token
fieldsNoCustom field values, keyed by field name: { "Priority": "High" }. For an option field, both the field name and the value must match an existing field and one of its options EXACTLY (see list_custom_fields) — one that does not exist comes back as an error naming the valid fields or options, while the rest of the update is still saved. The built-in Status field is set with `status`, not here. Typed fields take a plain string instead: a date field an ISO date (YYYY-MM-DD), a person field a member token (from list_members), a url field an http(s) URL; "" clears a typed field, and an unparseable value fails the whole update. list_custom_fields gives each field's `field_type` and exact name. Each supplied value REPLACES the asset's previous value for that field; custom fields omitted from the map remain unchanged. A value written on a group also applies to its members.
statusNoStatus label
descriptionNoNew description
ai_generatedNoMark the asset as produced by an AI tool. Prefer setting this when you CREATE the asset: on uploads that go through upload_prepare/upload_complete it also suppresses automatic duplicate merging and grouping, and that runs once the upload finishes — setting it later records the marker but cannot undo a merge.
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, so read the asset first if you mean to keep existing keys. You can read it back per asset (get_asset, or list/search with get_ai_payload=true) but you CANNOT search or filter on it — do not try to find assets by payload contents.
collection_tokenNoBoard token to move the asset to

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 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, so read the asset first if you mean to keep existing keys. You can read it back per asset (get_asset, or list/search with get_ai_payload=true) but you CANNOT search or filter on it — do not try to find assets by payload contents."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, so read the asset first if you mean to keep existing keys. You can read it back per asset (get_asset, or list/search with get_ai_payload=true) but you CANNOT search or filter on it — do not try to find assets by payload contents."
    • 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 / properties / fields / description
      Previous value: -"Custom field values, keyed by field name: { \"Priority\": \"High\" }. For an option field, both the field name and the value must match an existing field and one of its options EXACTLY (see list_custom_fields) — the API skips anything it cannot match and still reports success, so verify the returned `fields` map. Typed fields take a plain string instead: a date field an ISO date (YYYY-MM-DD), a person field a member token (from list_members), a url field an http(s) URL; \"\" clears a typed field, and an unparseable value fails the whole update. list_custom_fields gives each field's `field_type` and exact name. Each supplied value REPLACES the asset's previous value for that field; custom fields omitted from the map remain unchanged. A value written on a group also applies to its members."New value: +"Custom field values, keyed by field name: { \"Priority\": \"High\" }. For an option field, both the field name and the value must match an existing field and one of its options EXACTLY (see list_custom_fields) — one that does not exist comes back as an error naming the valid fields or options, while the rest of the update is still saved. The built-in Status field is set with `status`, not here. Typed fields take a plain string instead: a date field an ISO date (YYYY-MM-DD), a person field a member token (from list_members), a url field an http(s) URL; \"\" clears a typed field, and an unparseable value fails the whole update. list_custom_fields gives each field's `field_type` and exact name. Each supplied value REPLACES the asset's previous value for that field; custom fields omitted from the map remain unchanged. A value written on a group also applies to its members."
    • changedInput schema / required
      Previous value: -[
      -  "token",
      -  "context"
      -]New value: +[
      +  "token"
      +]
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true; the description usefully qualifies the destructiveness (only passed fields change, but tags REPLACE the existing set) and flags the list_custom_fields prerequisite for custom-field spelling. It does not mention permission requirements or what the response contains.

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 editable surface, then patch semantics, then the one actionable prerequisite. No filler and nothing buried.

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 10-parameter mutation tool with no output schema, the description plus the very rich input schema covers field semantics, replacement behavior, and the custom-field prerequisite. Gaps are limited to permissions and failure handling, which annotations partially offset.

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% and the schema already documents every parameter in depth, including the fields/status split and the list_custom_fields reference. The description's only added signal is the reminder that `fields` holds custom field VALUES, which the schema states as well, so baseline 3 applies.

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?

States a specific verb (update) plus the resource and enumerates the editable surface: title, description, tags, status, custom fields, and board move. It does not, however, name the overlapping siblings (update_asset_status, change_asset_tags, move_assets) that a caller might otherwise reach for.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Patch semantics are explicit ("Only the fields you pass are changed — omit a field to leave it as-is") and there is one prerequisite ("call list_custom_fields first"). But there is no when-not guidance and no routing away from update_asset_status / change_asset_tags / move_assets, which cover subsets of this tool's surface.

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