Skip to main content
Glama

Create customer application recipe

create_application_recipe
Idempotent

Create an immutable application recipe revision by resolving image tags, validating a digest-pinned Compose definition, and saving it without installing containers.

Instructions

Resolve image tags from their registries, validate the resulting digest-pinned Compose definition, and freeze that exact definition as the first immutable customer-owned recipe revision. This saves a definition only and does not install or start containers. If validation remains pending, retain its ID and resolved_compose_yaml, poll get_application_recipe_validation, then retry with validation_id and that exact pinned document. Plain environment values belong in env; secret_names contain names only. Confirm the exact service, name, Compose definition, variable names, and registry bindings first. Requires applications:manage.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
envNoPlain, non-secret environment values. Put secret values in the install tool's secrets field.
nameYesLowercase customer recipe name, 2-41 characters
orderNoYesTenant-owned service order number: 1-64 ASCII letters, digits or hyphens, e.g. VP12345 or VP12345-1
confirmedYesTrue only after the user confirmed this immutable recipe definition
compose_yamlYesDocker Compose YAML. Mutable image tags are resolved once and replaced with immutable sha256 digests before worker validation.
secret_namesNoSecret variable names only; definitions and exports never contain values
validation_idNoResume only the exact successful validation for this service and digest-pinned compose_yaml; retain the initial resolved document
idempotencyKeyYesClient-global unique key. Reuse it only to replay this exact recipe creation request.
registry_credential_idsNoOwned registry credential UUIDs from list_application_registry_credentials

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.3.16

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the annotations (which only declare idempotency and non-destructiveness), the description discloses irreversibility ('immutable'), the resolve-then-pin digest behavior, the pending-validation resume loop, and the required applications:manage scope. These are material behaviors not captured in the structured fields.

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-loads the core action, then the workflow, then the preconditions and permission. Dense but each sentence contributes; the closing confirmation list is slightly enumerative but useful for a 9-param tool.

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?

For a complex 9-parameter mutation with no output schema, the description covers the operation's semantics, the async validation/resume path, digest pinning, the env-vs-secrets contract, preconditions, and the required permission. Nothing essential to correct invocation is missing.

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 description coverage is 100%, so the schema already documents parameter meanings. The description largely restates the env/secret_names distinction that the schema covers, adding only marginal value (validation_id resume intent, 'names only' emphasis), so the baseline 3 is appropriate.

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?

Uses specific verbs (resolve, validate, freeze) on a specific resource (the first immutable customer-owned recipe revision) and explicitly distinguishes itself from install/start behavior. An agent can differentiate it from create_application_recipe_revision and install_application_recipe without opening any 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?

Gives explicit workflow guidance: confirm service/name/compose/variables/registry bindings first, and if validation is pending, retain the ID and poll get_application_recipe_validation then retry with validation_id. Also states the exclusion that it saves a definition only and does not install or start containers.

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

Deploy Server

Other Tools