Skip to main content
Glama

Get clueprint

get_clueprint
Read-only

Fetch clueprint data. Use include to control how much you pull back:

  • include="metadata": just the clueprint's name/description/tags/visibility/thumbnail.

  • include="tree": metadata + the full file tree (path, mime_type, and size per entry). Call this first when exploring an unfamiliar clueprint.

  • include="files": the contents of the files listed in file_paths (no metadata — call include='tree' first if you also need metadata). Text inline, binary as presigned GET URLs.

  • include="all": metadata + the file tree + the contents of every file in the clueprint (use sparingly on large clueprints).

Every read is logged for the workspace's recents. Pass use=true ONCE, when you start building a project from it: that counts the use (the clueprint's use count, apply analytics); add project_id when the project already exists.

Building from it: Brand kit vs clueprint: the brand kit sets WHO (logos, palette roles, fonts, icons, company facts, brand guidelines); the clueprint sets THE FORMAT (structure and layouts, pacing, motion, transitions, script and voiceover style, music, caption style and animation unless the kit has its own caption style, effects). With both, the kit wins on identity and the clueprint on format; the user's explicit ask beats both. Re-skin the clueprint's literal colors, fonts and logos to the project's kit roles (pick the logo variant by scene background). A community clueprint or another workspace's is always re-skinned, never shipping another company's logo; only this workspace's own clueprint with brand_locked: true keeps its colors, fonts and logos. The reply's brand says whether this clueprint is brand_locked for this workspace; pass clueprint_id with project_id to get_design_guide for the kit to re-skin with.

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": "get_clueprint"
  }
}

Input Schema

NameRequiredDescriptionDefault
useNotrue: you are building a project from this clueprint; counts the use. Once per build.
includeNoWhat to return: 'metadata' | 'tree' | 'files' | 'all'. Defaults to 'tree'.tree
file_pathsNoinclude='files' only: relative paths to read (e.g. ['design/colors.md', 'rules/voice.md']). Ignored for other modes.
project_idNouse=true only: the project being built from it, when it exists.
clueprint_idYesID of the clueprint.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / project_id
      Added value: +{
      +  "description": "use=true only: the project being built from it, when it exists.",
      +  "type": "string"
      +}
    • addedInput schema / properties / use
      Added value: +{
      +  "description": "true: you are building a project from this clueprint; counts the use. Once per build.",
      +  "type": "boolean"
      +}
  2. 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"
      +]
  3. 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"
      +]
  4. Changed2 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
  5. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only say readOnlyHint=true and destructiveHint=false, but the description discloses real side effects the annotations cannot: every read is logged into the workspace's recents, and use=true mutates the clueprint's use count and apply analytics. It also discloses return encoding (text inline, binary as presigned GET URLs) and the presence of a `brand`/brand_locked flag in the reply.

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 the verb, then a clean bulleted enumeration of modes, then logging/usage semantics, then the build guidance — a logical order with no filler. The closing brand-kit-vs-clueprint paragraph is dense and long for a fetch tool, though it directly informs the `use=true` decision, so it earns its place but costs some tightness.

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?

With five parameters, no output schema, and a mutation-adjacent `use` flag, the description covers the missing ground: return shapes per mode, side effects, re-skin/brand_locked policy, and the handoff to get_design_guide. An agent can call this correctly on the first try without reading anything else.

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 already 100%, so the baseline is 3; the description earns above that by expanding what each include value concretely contains ("metadata + the full file tree (path, mime_type, and size per entry)") and by noting file_paths is ignored outside include='files'. The semantics of `use` and `project_id` interplay (once per build, project_id only when the project exists) are also spelled out.

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 ("Fetch clueprint data") and immediately enumerates the four retrieval scopes, so an agent knows exactly what shape of data it is asking for. It is clearly a read of one clueprint, distinguishing it from create_clueprint and update_clueprint by scope and intent.

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 prescribes when to use each mode ("Call this first when exploring an unfamiliar clueprint", "call include='tree' first if you also need metadata", "use sparingly on large clueprints") and states the when-to-set condition for `use` ("Pass use=true ONCE, when you start building a project from it"). It also routes the agent to get_design_guide for the complementary brand-kit read.

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.