Skip to main content
Glama

sync_marketplace_orders

Pull orders from the channel NOW — a manual, one-off order import (in addition to the automatic sync that runs on its own when order sync is enabled). Use this when the user wants a marketplace's orders imported right now. The import runs asynchronously; watch the counts in marketplace_status.orderStats. Requires the marketplace's connection to be active for orders — otherwise returns status 'prerequisite_not_met' (HTTP 409). Returns {integrationId, action:'sync_orders', status, kind, editUrl, message}; status is 'updated' when the import was started. 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": "sync_marketplace_orders"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idNo
marketplace_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Goes well beyond the annotations by disclosing async execution, the progress-tracking path (marketplace_status.orderStats), the prerequisite failure mode with its exact status string and HTTP 409, and the full response envelope with status values. With annotations already declaring non-read-only and non-idempotent, the description adds the operational context an agent needs; only the concrete effects of repeat calls (why non-idempotency matters) are left unstated.

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?

Front-loaded with the action and its manual nature, then error behavior, then the response shape, then parameter sourcing. Despite being dense with contract details, every clause conveys information an agent needs to invoke or interpret the call.

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?

No output schema exists, but the description inlines the return object's fields and status semantics, plus the alternate failure payload. For a two-parameter asynchronous action tool, nothing material is missing.

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

Parameters5/5

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

Schema coverage is 0%, so the description carries the full burden and does: marketplace_id's source (list_marketplaces) and project_id's optionality, inference behavior for single-project customers, the project_id_required failure, and the follow-up call to list_projects. That is exactly the meaning missing from the bare integer 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?

States a specific verb and resource ('Pull orders from the channel NOW — a manual, one-off order import') and explicitly contrasts it with the automatic sync that runs when order sync is enabled. It also scopes the tool away from ads ('Marketplaces only — ads have no order sync'), so an agent can identify what it does and what it does not do.

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?

Gives a clear trigger ('Use this when the user wants a marketplace's orders imported right now') plus procedural guidance: marketplace_id comes from list_marketplaces and list_projects is needed when project_id_required appears. It never names the closest sibling, sync_project_orders, nor explains when project-wide sync is preferable, so the agent must infer the choice between the two order-sync tools.

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