Skip to main content
Glama

Create API template

create_api_template

Api template authoring — create a BRAND-NEW api template (mints the template + its version 1). Fetch the definition's JSON Schema with get_api_template_definition_schema and author against it. Iterate with execute_api_template before wiring the template into a workflow; pass publish=true to publish in the same step once you're happy. (To add a version to an api template that already exists, use create_api_template_version.)

Input Schema

TableJSON 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.
definitionYesThe api template definition, as a JSON object. Fetch the exact JSON Schema it must satisfy with get_api_template_definition_schema and author against it (or copy an existing one with the get_*_version tool). The owning service validates it on submit.
descriptionNoWhat external call this template makes.
display_nameNoHuman-readable name.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYes
versionYes
publishedYes
template_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations indicate this is a non-idempotent, non-read-only operation, and the description adds meaningful side-effect context by explaining that it mints the template and its version 1, and that publish=true publishes in the same step while omission leaves it as an unpublished draft. This is transparent beyond the annotations, though it does not explicitly warn that the operation is non-idempotent.

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 description is four sentences and contains no fluff, with the primary purpose front-loaded. The extra guidance on fetch/iterate/publish is useful but keeps it slightly longer than strictly necessary. Structure is clear and each sentence earns its place.

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?

The description covers purpose, workflow, publish behavior, and alternative tools, giving an agent enough context to use the tool correctly. Since an output schema exists, no return-value explanation is needed. It could have explicitly mentioned that this is a create operation for new templates only, but the 'BRAND-NEW' wording and contrast with create_api_template_version already convey that.

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% with already rich descriptions, so the baseline is 3. The overall description adds tool-level context (e.g., referencing get_api_template_definition_schema and the publish flow) that slightly supplements parameter understanding, but most parameter meaning already lives in the schema. The plus is that description clarifies the definition param's validation source, which is also present in the schema, so the net added value is modest.

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?

The description states a specific action: 'create a BRAND-NEW api template (mints the template + its version 1)', which clearly distinguishes it from sibling tools like create_api_template_version and update_api_template. The explicit pointer to create_api_template_version for adding versions to existing templates removes ambiguity.

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 description gives concrete workflow guidance: fetch the schema with get_api_template_definition_schema, author against it, iterate with execute_api_template, and optionally pass publish=true to publish in the same step. It also directs users to the alternative tool for adding versions to existing templates, covering when this tool should and should not be used.

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