Skip to main content
Glama

Create saved layout

create_schema

Save an extraction layout in this workspace. The slug (API id) is derived from the display name. A layout is {"type":"object","properties":{...}}. Each property is {"type":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that key. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds "items" (one node). An object adds "properties" and may add "required". At most 4 levels below the root, 100 keys, and 16384 bytes.

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": {
      "name": "<name>",
      "schema": "<schema>"
    },
    "name": "create_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesLabel shown in the console. Letters, digits, spaces, underscore, hyphen.
schemaYesA layout is {"type":"object","properties":{...}}. Each property is {"type":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that key. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds "items" (one node). An object adds "properties" and may add "required". At most 4 levels below the root, 100 keys, and 16384 bytes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Lowercase letters, digits, underscores, and hyphens. No spaces."New value: +"Label shown in the console. Letters, digits, spaces, underscore, hyphen."
    • removedInput schema / properties / name / pattern
      Removed value: -"^[a-z0-9_-]+$"
    • changedInput schema / properties / schema / description
      Previous value: -"A schema is {\"type\":\"object\",\"properties\":{...}}. Each property is {\"type\":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that field. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds \"items\" (one node). An object adds \"properties\" and may add \"required\". At most 4 levels below the root, 100 keys, and 16384 bytes."New value: +"A layout is {\"type\":\"object\",\"properties\":{...}}. Each property is {\"type\":T} where T is one of any, null, boolean, string, number, date, array, object. An optional description, at most 400 characters, tells the model how to read that key. An optional required array lists the keys that must be present. A date is a string yyyy-mm-dd. An array adds \"items\" (one node). An object adds \"properties\" and may add \"required\". At most 4 levels below the root, 100 keys, and 16384 bytes."
  2. First observed

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=false, so the safety profile is covered. The description genuinely adds that the slug/API id is derived from the display name (a non-obvious side effect relevant to the non-idempotent hint), but says nothing about failure on slug collision or what is returned after creation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first two sentences are well front-loaded, but roughly two-thirds of the text is a word-for-word duplicate of the nested schema's description (type vocabulary, 400-char descriptions, date format, array/object rules, and limits). That bulk restates structured data and crowds out genuinely missing information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a create operation on a deeply nested schema with no output schema, the description explains the payload grammar but omits the response shape (does it return the slug/id?), collision/validation failure behavior, and any prerequisite about the target workspace. The format details it does provide duplicate the schema, so the description is adequate but not sufficient on its own.

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 coverage is 100%, so the baseline is 3. The description does add one real semantic for the name parameter — that it determines the API slug — but the long block describing the layout grammar is copied verbatim from the schema property description, adding no meaning beyond it.

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?

"Save an extraction layout in this workspace" states a specific verb (save) and resource (extraction layout) with workspace scope. It is distinguishable from get_schema/list_schemas by implication, but it never names update_schema as the alternative for modifying an existing layout, so the create-vs-update boundary is left to inference.

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

Usage Guidelines2/5

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

No when-to-use guidance: nothing says when to call this instead of update_schema, what happens if a layout with the derived slug already exists, or whether the workspace must pre-exist. The only contextual hint is the phrase "in this workspace".

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