mcp-server

enable_marketplace_order_sync

Idempotent

Add ORDER SYNC to an existing marketplace — the capability, not the on/off switch. Use this when a marketplace has no order sync yet and the user wants it. Order sync has two layers: the capability (whether the marketplace pulls orders at all, which adds an 'order-settings' wizard step) and the active on/off mode (start_marketplace_order_sync / stop_marketplace_order_sync). This tool turns the CAPABILITY on for a marketplace created without it: it adds the order-settings step and leaves syncing OFF. Only offer it when get_marketplace reports canEnableOrderSync:true (the channel definition allows order sync and the store platform supports orders); otherwise it returns status 'prerequisite_not_met' (HTTP 409). After it succeeds: (1) re-fetch get_marketplace, find the new 'order-settings' step and configure it with configure_marketplace_step (a form step — payload {items:{fieldCode:value}} from the step's fields), then (2) call start_marketplace_order_sync to START syncing. Returns {integrationId, action:'enable_order_sync', status, kind, editUrl, message}; status is 'updated' (added, or already on) or 'prerequisite_not_met'. marketplace_id is from list_marketplaces. project_id is OPTIONAL (inferred for a single-project customer; project_id_required otherwise — then call list_projects). Marketplaces only — ads have no order sync.

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": {
      "marketplace_id": "<marketplace_id>"
    },
    "name": "enable_marketplace_order_sync"
  }
}

Input Schema

Name	Required	Description	Default
`project_id`	No
`marketplace_id`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedSep 1, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already declare idempotent=true and destructive=false, and the description adds substantial context beyond them: the side effect of adding an 'order-settings' wizard step while leaving syncing OFF, the 409 prerequisite behavior, and the exact return shape with status values. This is exactly the extra behavioral detail annotations cannot convey.

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-loaded with the core distinction and then the workflow, with no filler sentences. It is dense and slightly repetitive about the capability-vs-switch point, but every sentence carries operational information.

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 two-param mutation with no output schema, the description covers preconditions, side effects, return values, and the required follow-up calls. An agent has everything needed to invoke it correctly and handle the failure case.

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 0%, so the description must compensate, and it does: marketplace_id is sourced from list_marketplaces, and project_id is explained as optional/inferred with the project_id_required fallback to list_projects. It stops short of format/type detail, but the semantic meaning of both params is clear.

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?

States a specific verb and resource ('Add ORDER SYNC to an existing marketplace') and immediately disambiguates it from the on/off siblings (start_marketplace_order_sync / stop_marketplace_order_sync). The capability-vs-mode distinction lets an agent pick this tool 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?

Explicit when-to-use ('when a marketplace has no order sync yet and the user wants it'), an explicit precondition (get_marketplace reports canEnableOrderSync:true), the failure mode otherwise (409 prerequisite_not_met), and the follow-up sequence (configure_marketplace_step then start_marketplace_order_sync). It also excludes ads ('ads have no order sync').

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

All mcp-server tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?