Skip to main content
Glama

aidelly_connect_ecommerce_store

POST /ecommerce/stores — connect a new Shopify / WooCommerce / Etsy / Wix store. Verifies credentials then kicks off initial sync. Public API preview.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyNoOptional body override for endpoints with sparse parameter schemas.
queryNoOptional query overrides for endpoints with sparse parameter schemas.
brand_idNo
providerYes
shopDomainYes
credentialsYes
workspace_idNoWorkspace to operate in. Do not ask the user for this UUID — call aidelly_list_workspaces and use the `id` of the matching workspace. Optional for read operations; required when creating content.
idempotency_keyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / credentials / oneOf
      Previous value: -[
      -  {
      -    "description": "Shopify, Etsy, or Wix credentials.",
      -    "properties": {
      -      "accessToken": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "accessToken"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "description": "WooCommerce REST API credentials.",
      -    "properties": {
      -      "consumerKey": {
      -        "type": "string"
      -      },
      -      "consumerSecret": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "consumerKey",
      -      "consumerSecret"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "description": "Current Shopify Dev Dashboard app credentials.",
      +    "properties": {
      +      "clientId": {
      +        "type": "string"
      +      },
      +      "clientSecret": {
      +        "format": "password",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "clientId",
      +      "clientSecret"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "description": "Legacy Shopify, Etsy, or Wix credentials.",
      +    "properties": {
      +      "accessToken": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "accessToken"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "description": "WooCommerce REST API credentials.",
      +    "properties": {
      +      "consumerKey": {
      +        "type": "string"
      +      },
      +      "consumerSecret": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "consumerKey",
      +      "consumerSecret"
      +    ],
      +    "type": "object"
      +  }
      +]
  2. Changed1 schema field changed
    • addedInput schema / properties / workspace_id / description
      Added value: +"Workspace to operate in. Do not ask the user for this UUID — call aidelly_list_workspaces and use the `id` of the matching workspace. Optional for read operations; required when creating content."
  3. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already indicate this is a non-read, non-idempotent operation. The description adds useful behavioral detail by stating the sequence: credentials are verified first, then an initial sync is kicked off. It also flags 'Public API preview,' which is relevant stability context not available in the 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?

The description is a single, front-loaded sentence that states the endpoint, the action, the supported providers, and the main side effect without wasted words. 'Public API preview' is a brief but valuable stability cue.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex, non-idempotent mutation with 8 parameters, nested credential variants, and no output schema, the description is too thin. It omits crucial context such as why idempotency_key is required, what kind of response or asynchronous result to expect, and what happens if credential verification fails.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is low at 38%, so the description must compensate, but it does not explain required parameters like idempotency_key, shopDomain, or brand_id. It only repeats the supported providers already visible in the provider enum, adding little semantic value beyond the schema.

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 names a specific action ('connect a new...store'), the resource path, and the supported providers, clearly differentiating this from sibling tools like disconnect, sync, and get/list. It also states the immediate effect: 'Verifies credentials then kicks off initial sync.'

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?

The description provides clear context for when to invoke the tool: connecting a new Shopify, WooCommerce, Etsy, or Wix store. It does not name sibling alternatives like aidelly_sync_ecommerce_store, but the 'new store' framing and mention of 'initial sync' make the intended use reasonably unambiguous.

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.