Clueso

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

Name	Required	Description	Default
`mode`	No	'add' returns required + optional fields; 'update' returns all-optional.	add
`query`	No	Words describing the property you want ('pill background', 'corner radius', 'line height'): returns the best-matching fields (up to 5) as `fields` would.
`detail`	No	'compact' (default): names, types and one-line notes. 'full': every field's full notes, nested docs and the keyframe rules.
`fields`	No	Return only these fields, with their full notes, default and an example — text is 15KB whole, ~300 bytes for two.
`format`	No	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.
`element_type`	Yes	One of: text, callout, rectangle, arrow, blur, spotlight, zoom, image, video, animation, question, results, form, avatar, group

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedOct 27, 2026

changedInput schema / properties / element_type / description

Previous value: -"One of: text, callout, rectangle, arrow, blur, spotlight, zoom, image, video, animation, avatar, group"New value: +"One of: text, callout, rectangle, arrow, blur, spotlight, zoom, image, video, animation, question, results, form, avatar, group"

changedInput schema / properties / element_type / enum

Previous value: -[
-  "text",
-  "callout",
-  "rectangle",
-  "arrow",
-  "blur",
-  "spotlight",
-  "zoom",
-  "image",
-  "video",
-  "animation",
-  "avatar",
-  "group"
-]New value: +[
+  "text",
+  "callout",
+  "rectangle",
+  "arrow",
+  "blur",
+  "spotlight",
+  "zoom",
+  "image",
+  "video",
+  "animation",
+  "question",
+  "results",
+  "form",
+  "avatar",
+  "group"
+]

Changed3 schema fields changedOct 12, 2026

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"
+}

Changed2 schema fields changedOct 12, 2026

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"
+]

Changed4 schema fields changedSep 22, 2026

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"
+]

Changed4 schema fields changedSep 22, 2026

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"
+]

Changed2 schema fields changedSep 17, 2026

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
```

Changed4 schema fields changedSep 15, 2026

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"
+}

First observedAug 11, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already declare readOnly/non-destructive/non-open-world, so the bar is lower, yet the description adds real behavior: compact is the default, detail:'full' exposes keyframe rules, and format silently flips to 'json' inside run_script. That default-switching nuance is exactly the kind of thing annotations cannot convey.

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 the default behavior, then the query/fields variants, then naming conventions. Four paragraphs is on the long side and the format/run_script point is restated twice, but almost every sentence carries an operational fact.

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 no output schema, the description still conveys the return shape: TypeScript declarations with types, one-line notes and keyframable list by default, full notes/defaults/examples for targeted fields. An agent knows what it will receive and how to narrow it.

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 still adds value by explaining the fields/query interaction (query returns up to 5 matches 'as fields would'), and by documenting camelCase field naming with the snake_case cross-reference that appears nowhere in the schema. The group surface explanation is extra semantics the enum alone doesn't supply.

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 and resource ('Return the schema for an element type's type_data, as TypeScript declarations') and makes the artifact concrete. It is clearly distinguishable from siblings like get_clip or add_elements, which it names as downstream consumers.

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 says to call it before add_elements/update_elements when the field shape is unknown, and gives a separate routing rule for element_type='group'. The when-not condition ('when you don't already know the field shape') is stated plainly.

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

All Clueso tools Inspect

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.

Get element schema

Input Schema

Schema Changelog

TDQS

Glama MCP Gateway

Resources