Skip to main content
Glama

Update clueprint

update_clueprint
Destructive

Update a clueprint's metadata and/or file contents in one call.

Metadata fields (name, description, tags, visibility, thumbnail_path) are applied as a patch — only the fields you pass change. Pass at least one to update metadata.

files is a list of file mutations:

  • Write text: { path, content }

  • Write binary: { path, content, encoding: "base64" }

  • Write from URL: { path, source_url } (presigned URL, e.g. from get_clip with save=true)

  • Delete: { path, content: null }

You can mix writes and deletes in a single call. Existing files at the same path are overwritten.

brand_locked: true keeps the clueprint's own colors, fonts and logos for projects in this workspace; false (the default) re-skins them to each project's brand kit. Only this workspace's clueprints; a community clueprint is always re-skinned.

decisions records the build-time choices create_clueprint left pending, after you ask the user: animation_modes / image_modes ({id: mode}), voiceover_policies ({source_clip_id: policy}), split_decision, slide_count_strategy, allowed_element_types, the *_by_role variants for all-slides sources ({role: ...} from the *_by_role groups), and finalize_layout_texts: true (once every layouts/-/layout.md exists). Each applies on its own; failures come back in decision_errors.

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": {
      "clueprint_id": "<clueprint_id>"
    },
    "name": "update_clueprint"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoNew name.
tagsNoNew tags (replaces existing).
filesNoFile mutations — writes and deletes. Empty/omitted for metadata-only updates.
decisionsNoBuild-time decisions to record (see the description).
visibilityNoNew visibility.
descriptionNoNew description.
brand_lockedNotrue: projects built from it keep its own colors, fonts and logos; false: re-skinned to each project's brand kit.
clueprint_idYesID of the clueprint to update.
thumbnail_pathNoRelative path of a screenshot in the clueprint to use as thumbnail (e.g. 'screenshots/title-slide.png').

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / brand_locked
      Added value: +{
      +  "description": "true: projects built from it keep its own colors, fonts and logos; false: re-skinned to each project's brand kit.",
      +  "type": "boolean"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / decisions
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Build-time decisions to record (see the description).",
      +  "properties": {
      +    "allowed_element_types": {
      +      "items": {
      +        "properties": {
      +          "allowed": {
      +            "items": {
      +              "enum": [
      +                "zoom",
      +                "spotlight",
      +                "callout",
      +                "rectangle"
      +              ],
      +              "type": "string"
      +            },
      +            "minItems": 1,
      +            "type": "array"
      +          },
      +          "clip_type": {
      +            "enum": [
      +              "slide_clip",
      +              "video_clip"
      +            ],
      +            "type": "string"
      +          },
      +          "user_added_rules": {
      +            "additionalProperties": {
      +              "type": "string"
      +            },
      +            "description": "{type: rule}",
      +            "propertyNames": {
      +              "type": "string"
      +            },
      +            "type": "object"
      +          }
      +        },
      +        "required": [
      +          "clip_type",
      +          "allowed"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "animation_modes": {
      +      "additionalProperties": {
      +        "enum": [
      +          "reuse",
      +          "reuse_and_modify",
      +          "user_uploaded"
      +        ],
      +        "type": "string"
      +      },
      +      "description": "{animation_id: mode}; user_uploaded = a logo animation the user uploads at build",
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "finalize_layout_texts": {
      +      "const": true,
      +      "type": "boolean"
      +    },
      +    "image_modes": {
      +      "additionalProperties": {
      +        "enum": [
      +          "reuse",
      +          "reuse_and_modify",
      +          "screenshot_from_guide",
      +          "user_uploaded"
      +        ],
      +        "type": "string"
      +      },
      +      "description": "{image_id: mode}",
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "image_modes_by_role": {
      +      "additionalProperties": {
      +        "additionalProperties": {
      +          "enum": [
      +            "reuse",
      +            "reuse_and_modify",
      +            "screenshot_from_guide",
      +            "user_uploaded"
      +          ],
      +          "type": "string"
      +        },
      +        "propertyNames": {
      +          "type": "string"
      +        },
      +        "type": "object"
      +      },
      +      "description": "{role: {purpose_cluster: mode}}",
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "slide_count_strategy": {
      +      "properties": {
      +        "basis": {
      +          "enum": [
      +            "one_body_slide_per_user_upload",
      +            "one_body_slide_per_heading",
      +            "one_body_slide_per_section",
      +            "one_body_slide_per_h1",
      +            "fixed_count",
      +            "ask_per_build",
      +            "user_override"
      +          ],
      +          "type": "string"
      +        },
      +        "source": {
      +          "enum": [
      +            "inferred",
      +            "user_confirmed",
      +            "user_override"
      +          ],
      +          "type": "string"
      +        },
      +        "target_count": {
      +          "description": "fixed_count: body slides",
      +          "maximum": 9007199254740991,
      +          "minimum": 0,
      +          "type": "integer"
      +        }
      +      },
      +      "required": [
      +        "basis"
      +      ],
      +      "type": "object"
      +    },
      +    "split_decision": {
      +      "properties": {
      +        "decision": {
      +          "enum": [
      +            "keep_as_one",
      +            "optimal_at_creation",
      +            "user_instruction"
      +          ],
      +          "type": "string"
      +        },
      +        "instruction": {
      +          "description": "Required for user_instruction",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "decision"
      +      ],
      +      "type": "object"
      +    },
      +    "voiceover_policies": {
      +      "additionalProperties": {
      +        "enum": [
      +          "retain_silent",
      +          "generate"
      +        ],
      +        "type": "string"
      +      },
      +      "description": "{source_clip_id: policy}",
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    },
      +    "voiceover_policies_by_role": {
      +      "additionalProperties": {
      +        "enum": [
      +          "retain_silent",
      +          "generate"
      +        ],
      +        "type": "string"
      +      },
      +      "description": "{role: policy}",
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Changed4 schema fields changed
    • removedInput schema / properties / context
      Removed value: -{
      -  "description": "Explain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as \"a user\", \"the customer\", or \"an account\". Example: \"Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution.\"",
      -  "type": "string"
      -}
    • removedInput schema / properties / conversation_id
      Removed value: -{
      -  "description": "Echo the conversation_id from the server's previous response. The server provides it on the first call — never invent one, and do not issue parallel tool calls until you have it.",
      -  "type": "string"
      -}
    • removedInput schema / properties / llm_model
      Removed value: -{
      -  "description": "The exact model identifier you (the assistant) are running as, taken from your system prompt or environment (e.g. \"claude-opus-4-8\", \"gpt-5.2\"). Used for analytics only. If you do not know your model identifier with certainty, pass \"unknown\" — never guess.",
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "clueprint_id",
      -  "context",
      -  "llm_model"
      -]New value: +[
      +  "clueprint_id"
      +]
  4. Changed4 schema fields changed
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Explain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as \"a user\", \"the customer\", or \"an account\". Example: \"Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution.\"",
      +  "type": "string"
      +}
    • addedInput schema / properties / conversation_id
      Added value: +{
      +  "description": "Echo the conversation_id from the server's previous response. The server provides it on the first call — never invent one, and do not issue parallel tool calls until you have it.",
      +  "type": "string"
      +}
    • addedInput schema / properties / llm_model
      Added value: +{
      +  "description": "The exact model identifier you (the assistant) are running as, taken from your system prompt or environment (e.g. \"claude-opus-4-8\", \"gpt-5.2\"). Used for analytics only. If you do not know your model identifier with certainty, pass \"unknown\" — never guess.",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "clueprint_id"
      -]New value: +[
      +  "clueprint_id",
      +  "context",
      +  "llm_model"
      +]
  5. Changed3 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • removedInput schema / properties / files / items / additionalProperties
      Removed value: -false
  6. First observed

TDQS

A4.2/5.0
Behavior5/5

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

Annotations only flag destructiveHint=true; the description concretely says what gets destroyed — "Existing files at the same path are overwritten" and delete via `content: null` — and that failures are reported per-decision in `decision_errors`. It also explains brand_locked's re-skinning side effect and the community-clueprint exception, adding genuine behavioral context beyond the annotations.

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-loads the one-line purpose, then organizes the rest under terse labels and bullets with no filler sentences. It is dense but every block corresponds to a parameter group; only the `decisions` paragraph is heavy enough to warrant a second read.

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?

This is a complex tool (9 params, deeply nested decision objects, no output schema), and the description covers patch semantics, file mutation modes, brand behavior, and failure reporting well enough to call it correctly. Gaps are minor—enum-level meanings for the various mode values are left entirely to the schema.

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, but the description adds real meaning: the four concrete `files` mutation shapes, which `decisions` keys come from `*_by_role` groups, and the condition that triggers `finalize_layout_texts`. It leaves individual enum semantics (e.g. reuse_and_modify, screenshot_from_guide) unexplained, so not a 5.

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?

Opens with a specific verb and resource plus scope: "Update a clueprint's metadata and/or file contents in one call." That precisely separates it from get_clueprint and create_clueprint. It stops short of explicitly naming siblings or stating what it does not do, so it lands at 4 rather than 5.

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 real usage conditions: metadata is a patch so "pass at least one to update metadata," writes and deletes can be mixed, and `decisions` is recorded "after you ask the user" with `finalize_layout_texts: true` gated on every layout.md existing. No explicit when-not-use or alternative routing, but the preconditions are unusually clear.

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.