Skip to main content
Glama

Get install steps

get_install_steps
Idempotent

Returns step-by-step instructions to connect a shop to one store, for its platform, and records the platform on the store. WooCommerce, PrestaShop, Magento and Shopware connect with one click from the plugin.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "store_id": "<store_id>",
      "platform": "<platform>"
    },
    "name": "get_install_steps"
  }
}

Input Schema

NameRequiredDescriptionDefault
platformYesOnly these platforms have an Emporiqa plugin. 'webhook' means a developer connects a custom shop. Other platforms (e.g. Shopify, Wix) are not supported yet.
store_idYesThe store's store_id (not its name).

Output Schema

NameRequiredDescriptionDefault
stepsYes
platformNo
store_idYes
one_clickNo
platform_labelNo
shop_admin_urlNoThe shop admin page to start from, when its address is fixed; it comes from the shop's website in the site lock.
setup_guide_urlYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations mark this as non-read-only, and the description earns that by disclosing the actual write: it records the platform on the store, which is the critical mutation an agent needs to know about before calling. It adds that WooCommerce/PrestaShop/Magento/Shopware connect in one click, but says nothing about permissions or whether an existing stored platform is overwritten.

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?

Two sentences, front-loaded with the primary outcome and the write side effect before the platform commentary. The one-click sentence is short and useful for setting expectations, with no filler.

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 value detail is unnecessary, and the description covers purpose, the platform constraint, and the mutation. The only real omission is how this relates to set_up_store and whether the platform recording can conflict with existing store settings.

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 both parameters are already documented, including the enum caveat about unsupported platforms like Shopify and Wix. The description reinforces that the steps are per-platform and per-single-store, but adds no syntax or format detail beyond the schema, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: returns step-by-step connection instructions for a shop to a single store on a given platform, plus the side effect of recording that platform. An agent can distinguish this from generic store tools, though it never names set_up_store or any other sibling explicitly.

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

Usage Guidelines3/5

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

Usage is implied by the inputs (call it when you have a store_id and platform and need connection steps), and the enumeration of one-click platforms scopes the practical cases. There is no explicit when-to-use/when-not guidance relative to set_up_store or apply_store_settings, leaving the agent to infer the boundary.

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