Skip to main content
Glama

Get Store Template Install Options

get_store_template_install_options
Read-onlyIdempotent

Returns the displays the user can install a store template on plus the data slots it needs (key, label, type, required). Call before send_store_template_to_display. An empty displays list means the user must first set up a display (pair_by_code). Requires content scope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesTemplate slug returned by search_store_templates, e.g. 'bistro-warm-door'.
languageNoPreferred UI language for labels. Defaults to 'en'.
access_tokenNoOptional bearer token; prefer session_request_id.
session_request_idNoSession handle from create_auth_session; pass it on every authenticated call.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
displaysNo
languageNo
templateSlugNo
requiredDataSlotsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / access_token / description
      Previous value: -"Optional JWT access token."New value: +"Optional bearer token; prefer session_request_id."
    • changedInput schema / properties / session_request_id / description
      Previous value: -"Optional session request ID from create_auth_session. Preferred over access_token."New value: +"Session handle from create_auth_session; pass it on every authenticated call."
  2. Changed14 schema fields changed
    • changedOutput schema / properties / displays / items / properties / displayId / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / displays / items / properties / groupId / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / displays / items / properties / isLocked / type
      Previous value: -"boolean"New value: +[
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / displays / items / properties / name / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / displays / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / displays / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • changedOutput schema / properties / language / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / requiredDataSlots / items / properties / key / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / requiredDataSlots / items / properties / label / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / requiredDataSlots / items / properties / placeholderName / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
    • changedOutput schema / properties / requiredDataSlots / items / properties / required / type
      Previous value: -"boolean"New value: +[
      +  "boolean",
      +  "null"
      +]
    • changedOutput schema / properties / requiredDataSlots / items / type
      Previous value: -"object"New value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / requiredDataSlots / type
      Previous value: -"array"New value: +[
      +  "array",
      +  "null"
      +]
    • changedOutput schema / properties / templateSlug / type
      Previous value: -"string"New value: +[
      +  "string",
      +  "null"
      +]
  3. Changed12 schema fields changed
    • removedInput schema / properties / access_token / default
      Removed value: -null
    • changedInput schema / properties / access_token / description
      Previous value: -"Optional JWT access token (use session_request_id instead when possible)."New value: +"Optional JWT access token."
    • changedInput schema / properties / access_token / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
    • removedInput schema / properties / language / default
      Removed value: -null
    • changedInput schema / properties / language / description
      Previous value: -"Preferred UI language for labels. 'de' or 'en'. Defaults to 'en'."New value: +"Preferred UI language for labels. Defaults to 'en'."
    • addedInput schema / properties / language / enum
      Added value: +[
      +  "de",
      +  "en"
      +]
    • changedInput schema / properties / language / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
    • removedInput schema / properties / session_request_id / default
      Removed value: -null
    • changedInput schema / properties / session_request_id / description
      Previous value: -"Optional session request ID returned by create_auth_session. Preferred."New value: +"Optional session request ID from create_auth_session. Preferred over access_token."
    • changedInput schema / properties / session_request_id / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
    • changedInput schema / properties / slug / description
      Previous value: -"The template slug returned by search_store_templates, e.g. 'bistro-warm-door'."New value: +"Template slug returned by search_store_templates, e.g. 'bistro-warm-door'."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "displays": {
      +      "items": {
      +        "properties": {
      +          "displayId": {
      +            "type": "string"
      +          },
      +          "groupId": {
      +            "type": "string"
      +          },
      +          "isLocked": {
      +            "type": "boolean"
      +          },
      +          "name": {
      +            "type": "string"
      +          },
      +          "scope": {
      +            "enum": [
      +              "personal",
      +              "group"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "language": {
      +      "type": "string"
      +    },
      +    "requiredDataSlots": {
      +      "items": {
      +        "properties": {
      +          "key": {
      +            "type": "string"
      +          },
      +          "label": {
      +            "type": "string"
      +          },
      +          "placeholderName": {
      +            "type": "string"
      +          },
      +          "required": {
      +            "type": "boolean"
      +          },
      +          "type": {
      +            "enum": [
      +              "value",
      +              "aggregate"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "templateSlug": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  4. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already indicate readOnlyHint, idempotentHint, destructiveHint. Description adds 'Requires content scope' authorization context. No contradictions; adds value beyond annotations.

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

Conciseness5/5

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

Three sentences, all essential: purpose, prerequisite, edge case. No redundant words, front-loaded with key action.

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?

Has output schema for return values, annotations for safety, parameters fully documented, and description covers usage order and edge case. Complete for this tool's complexity.

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%, baseline 3. Description enhances slug with 'returned by search_store_templates', language as 'preferred UI language', and clarifies access_token vs session_request_id usage.

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 clearly states it returns displays and data slots for a store template, with specific fields like key, label, type, required. It distinguishes from sibling tools like send_store_template_to_display and search_store_templates.

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

Usage Guidelines4/5

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

Explicitly says 'Call before send_store_template_to_display', providing clear sequential usage. Also notes the empty displays list implies setup with pair_by_code, but does not exhaustively list when not to use.

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