Skip to main content
Glama

Clueso

by io.clueso
OverviewDiscussionsAdmin

Get element schema

get_element_schema
Read-only

Return the schema for an element type's type_data, as TypeScript declarations. Call this before add_elements / update_elements when you don't already know the field shape for the element_type you're placing.

By default it is compact: every field with its type and a one-line note, plus the keyframable list. Ask about specific properties with fields: ['background_setting'] or query: 'pill background' — those come back with their full notes, default and an example; detail: 'full' returns everything, including the keyframe rules. Inside run_script it is a function like any tool: get_element_schema({element_type: 'text', query: 'line height'}) looks a property up mid-script.

Fields are listed in camelCase, the names get_clip returns. Where the tool descriptions write one in snake_case (font_setting, animation_setting), the field says so — (= font_setting) on fontSetting — and either spelling is accepted.

Pass element_type='group' for the GROUP surface instead — what a group is, how its pivot works, and the nine properties it can animate.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNo'add' returns required + optional fields; 'update' returns all-optional.add
queryNoWords describing the property you want ('pill background', 'corner radius', 'line height'): returns the best-matching fields (up to 5) as `fields` would.
detailNo'compact' (default): names, types and one-line notes. 'full': every field's full notes, nested docs and the keyframe rules.
fieldsNoReturn only these fields, with their full notes, default and an example — text is 15KB whole, ~300 bytes for two.
formatNoDefaults to 'declarations' — TypeScript-style, which is the better READ. Inside run_script it defaults to 'json' instead, because a script indexes into the structure and the declaration text would arrive newline-escaped. Set it explicitly to override either default.
element_typeYesOne of: text, callout, rectangle, arrow, blur, spotlight, zoom, image, video, animation, avatar, group

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / detail
      Added value: +{
+  "description": "'compact' (default): names, types and one-line notes. 'full': every field's full notes, nested docs and the keyframe rules.",
+  "enum": [
+    "compact",
+    "full"
+  ],
+  "type": "string"
+}
    • changedInput schema / properties / fields / description
      Previous value: -"Return only these fields, with their prose — text is 15KB whole, ~300 bytes for two. Omit while learning the type: only the full schema carries the keyframable list and the keyframe rules."New value: +"Return only these fields, with their full notes, default and an example — text is 15KB whole, ~300 bytes for two."
    • addedInput schema / properties / query
      Added value: +{
+  "description": "Words describing the property you want ('pill background', 'corner radius', 'line height'): returns the best-matching fields (up to 5) as `fields` would.",
+  "maxLength": 80,
+  "minLength": 2,
+  "type": "string"
+}
  2. Changed2 schema fields changed
    • changedInput schema / properties / element_type / description
      Previous value: -"One of: text, callout, rectangle, arrow, blur, spotlight, zoom, image, video, animation, group"New value: +"One of: text, callout, rectangle, arrow, blur, spotlight, zoom, image, video, animation, avatar, group"
    • changedInput schema / properties / element_type / enum
      Previous value: -[
-  "text",
-  "callout",
-  "rectangle",
-  "arrow",
-  "blur",
-  "spotlight",
-  "zoom",
-  "image",
-  "video",
-  "animation",
-  "group"
-]New value: +[
+  "text",
+  "callout",
+  "rectangle",
+  "arrow",
+  "blur",
+  "spotlight",
+  "zoom",
+  "image",
+  "video",
+  "animation",
+  "avatar",
+  "group"
+]
  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: -[
-  "element_type",
-  "context",
-  "llm_model"
-]New value: +[
+  "element_type"
+]
  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: -[
-  "element_type"
-]New value: +[
+  "element_type",
+  "context",
+  "llm_model"
+]
  5. 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
  6. Changed4 schema fields changed
    • changedInput schema / properties / element_type / description
      Previous value: -"One of: text, callout, rectangle, arrow, blur, spotlight, zoom, image, video, animation"New value: +"One of: text, callout, rectangle, arrow, blur, spotlight, zoom, image, video, animation, group"
    • changedInput schema / properties / element_type / enum
      Previous value: -[
-  "text",
-  "callout",
-  "rectangle",
-  "arrow",
-  "blur",
-  "spotlight",
-  "zoom",
-  "image",
-  "video",
-  "animation"
-]New value: +[
+  "text",
+  "callout",
+  "rectangle",
+  "arrow",
+  "blur",
+  "spotlight",
+  "zoom",
+  "image",
+  "video",
+  "animation",
+  "group"
+]
    • addedInput schema / properties / fields
      Added value: +{
+  "description": "Return only these fields, with their prose — text is 15KB whole, ~300 bytes for two. Omit while learning the type: only the full schema carries the keyframable list and the keyframe rules.",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
    • addedInput schema / properties / format
      Added value: +{
+  "description": "Defaults to 'declarations' — TypeScript-style, which is the better READ. Inside run_script it defaults to 'json' instead, because a script indexes into the structure and the declaration text would arrive newline-escaped. Set it explicitly to override either default.",
+  "enum": [
+    "declarations",
+    "json"
+  ],
+  "type": "string"
+}
  7. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered; the description then adds genuinely new behavior: compact-by-default output, detail='full' exposing keyframe rules, fields/query returning full notes plus defaults and examples, and a different format default inside run_script because declaration text would arrive newline-escaped. It also discloses the camelCase/snake_case alias rule and the (= font_setting) marker.

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?

Purpose and the call-before-placement instruction are front-loaded, and the later paragraphs on format defaults, naming aliases, and the group surface each carry distinct, non-redundant information. It is longer than typical but avoids filler, landing slightly above the ideal size.

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?

There is no output schema, so the description carries the return-format burden and does so explicitly: compact mode yields names, types, one-line notes and the keyframable list; full mode adds nested docs and keyframe rules; query returns up to 5 best-matching fields. Nothing an agent needs to call and interpret this tool is missing.

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% and every parameter is already documented, so the baseline is 3. The description goes further by showing concrete invocation patterns (fields: ['background_setting'], query: 'pill background', detail: 'full') and clarifying that field values must use camelCase names as returned by get_clip, which directly affects how the `fields` parameter must be populated.

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 precise verb and resource — return the type_data schema for an element type as TypeScript declarations — and distinguishes itself from siblings by referencing get_clip as the canonical field-name source. An agent can tell immediately this is a schema-lookup tool, not a data or element-mutation tool.

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 an explicit usage trigger: call before add_elements/update_elements when the field shape is unknown, and recommends element_type='group' for the group surface. It does not name an alternative sibling (e.g. get_design_guide) or state when this tool is unnecessary, so it falls just short of full when/when-not coverage.

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

All Clueso 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