Skip to main content
Glama

Apply schema template

apply_template
Idempotent

Apply a curated schema template from the workspace's registry — a pre-vetted bundle of objects, fields, pick-list values, pipelines and starter views — in one step (admin-only). Idempotent: existing keys are skipped, so re-applying or overlapping templates never duplicates. describe_schema's templates section lists every key with its label, blurb and what it provisions (object / field / pipeline / program counts); an unknown key returns the available templates with a did-you-mean. Returns what was created plus the workspace's refreshed enabled objects.

When to use: When an admin wants to adopt a whole curated bundle at once — objects, fields, pick-list values, pipelines and starter views — instead of defining each piece. Idempotent: re-applying only adds what's missing.

Example: We send priced quotes — set up the quoting template.

Input Schema

NameRequiredDescriptionDefault
template_keyYesKey of a curated template — one of describe_schema's `templates` keys (e.g. account_hierarchy, quoting); an unknown key returns the available templates instead.

Output Schema

NameRequiredDescriptionDefault
appliedNo
createdNo
workspaceNo
did_you_meanNo
template_keyNo
available_templatesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  2. Changed7 schema fields changed
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / available_templates / items / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / created / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / properties / did_you_mean / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / did_you_mean / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / workspace / additionalProperties
      Removed value: -false
  3. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations (idempotentHint, destructiveHint=false), the description discloses admin-only authorization, the idempotency mechanism ('existing keys are skipped', so no duplication on overlap), unknown-key handling ('did-you-mean'), and the return payload. This is exactly the context annotations cannot carry.

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?

Well front-loaded and appropriately scoped, but idempotency is stated twice ('Idempotent: existing keys are skipped' and again in When-to-use as 're-applying only adds what's missing'), a minor redundancy in an otherwise tight description.

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?

An output schema exists, so return values need only a passing mention, which is given. Authorization, idempotency, error behavior, and the key-discovery path are all covered, leaving nothing an agent needs in order to call this correctly.

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 terse schema baseline would be 3, but the description adds real navigation value: it tells the agent the key comes from describe_schema's `templates` section, gives examples (account_hierarchy, quoting), and states unknown-key behavior.

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 ('Apply a curated schema template') and immediately characterizes the resource as 'a pre-vetted bundle of objects, fields, pick-list values, pipelines and starter views.' This clearly distinguishes it from the many define_*/archive_* siblings that operate on single pieces.

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?

The 'When to use' section explicitly frames the case ('adopt a whole curated bundle at once ... instead of defining each piece'), routing the agent away from the granular define_* siblings. It also gives a concrete example (quoting).

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