Skip to main content
Glama

start_marketplace_order_sync

Idempotent

Start importing a marketplace's orders: Koongo registers order webhooks with the marketplace. Use this when the user wants a marketplace's orders to flow into the shop. Needs order sync on the marketplace: otherwise 'prerequisite_not_met' (HTTP 409) — call enable_marketplace_order_sync and configure its order-settings step first. 'rejected' when order sync is not included in this Koongo account. Returns {integrationId, action:'set_order_mode', status, kind, editUrl, message}. Undo with stop_marketplace_order_sync. marketplace_id is from list_marketplaces. project_id is OPTIONAL (inferred for a single-project customer; project_id_required otherwise — then call list_projects).

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": "start_marketplace_order_sync"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idNo
marketplace_idYesintegrationId of the marketplace (from list_marketplaces).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior4/5

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

The description details significant behavior beyond the annotations, including the specific failure codes (HTTP 409) and the existence of the reversal action using `stop_marketplace_order_sync`. This adds necessary operational context for the AI agent.

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?

The definition is dense but highly efficient, prioritizing the core function and prerequisites at the beginning. Although it is a single block of text, every sentence serves to provide critical information for tool invocation.

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?

The definition is exceptionally complete for a state-changing API call. It covers the purpose, prerequisites, error handling, the reverse operation, and even provides a sample return structure.

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?

Given that the schema description coverage is only 50%, the description is vital. It provides crucial business context, explaining that `marketplace_id` must originate from `list_marketplaces` and explaining the conditional nature of `project_id` based on project configuration.

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 the action (Start importing marketplace orders) and the mechanism (Koongo registers order webhooks). It is highly specific and distinguishes this setup tool from synchronization or configuration tools.

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?

It provides explicit usage constraints, warning that prerequisite order sync must be enabled via `enable_marketplace_order_sync` before attempting this call. Furthermore, it defines distinct failure modes ('prerequisite_not_met' and 'rejected').

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