Skip to main content
Glama

Create schema

create_schema

Schema authoring — create a BRAND-NEW schema (mints the schema + its version 1). json_schema is the JSON Schema body datafiles bound to this schema (by schema_id) are validated against; property order is preserved exactly — it sets the field order of the generated editor, so author it in the order you want humans to see. Media uploads, entity references, cron and colors need an x-tessryx-ui hint or they render as bare text — get_guide("schemas"). Pass publish=true to publish schema version 1 immediately (the version datafiles resolve by default), or later with publish_schema. (To add a version to a schema that already exists, use create_schema_version.)

Input Schema

NameRequiredDescriptionDefault
slugYesURL-safe slug, optionally hierarchical.
publishNoIf true, immediately publish the version this call creates (the common create-then-publish in one step). Defaults to false; omit to leave the version as an unpublished draft.
descriptionNoWhat this schema describes.
json_schemaYesThe JSON Schema body datafiles validate against; becomes version 1. Property order is preserved verbatim.
display_nameYesHuman-readable name. Required (cannot be blank).

Output Schema

NameRequiredDescriptionDefault
slugYes
versionYes
publishedYes
schema_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / display_name / description
      Previous value: -"Human-readable name."New value: +"Human-readable name. Required (cannot be blank)."
    • changedInput schema / required
      Previous value: -[
      -  "slug",
      -  "json_schema"
      -]New value: +[
      +  "slug",
      +  "display_name",
      +  "json_schema"
      +]
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations declare readOnly=false, idempotent=false, destructive=false, but the description adds real substance beyond them: the call mints a schema plus version 1, property order is preserved verbatim and drives editor field order, and omitting publish leaves an unpublished draft. It stops short of covering failure modes such as slug collisions or permission requirements, which matters for a non-idempotent creation tool.

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?

The core identity ('create a BRAND-NEW schema') is front-loaded and every clause carries information, but the description is a single dense block of em-dash-separated fragments that is harder to scan than it could be. Nothing is redundant, though the parenthetical about create_schema_version could stand alone more cleanly.

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?

With an output schema present, return values need no explanation, and the description covers the creation semantics, publish flow, and json_schema authoring constraints for a 5-parameter tool with nested objects. Missing: behavior on duplicate slug or validation failure of the supplied json_schema, which an agent creating a resource would want to know.

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 baseline is 3, but the description goes beyond the schema for json_schema by explaining the consequence of property order (it sets editor field order) and that media/entity/cron/color fields need x-tessryx-ui hints. The publish parameter's effect on version resolution is also clarified. Minor gap: 'hierarchical' slug syntax is left to the schema.

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 (create) and resource (schema) with a precise scope: 'BRAND-NEW schema (mints the schema + its version 1)'. It also explicitly distinguishes itself from create_schema_version and publish_schema, so an agent can route correctly without opening a schema.

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?

Names the alternative directly ('To add a version to a schema that already exists, use create_schema_version') and explains the two publish paths: publish=true now versus publish_schema later. It also routes to get_guide("schemas") when x-tessryx-ui hints are needed, which is a genuine when-to-use pointer.

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