Skip to main content
Glama

marketplace_status

Read-onlyIdempotent

Get the live run status of one marketplace: readiness, connection, and product/order counts. Use this to check a marketplace's run progress and product counts. Returns {integrationId, status, ready, lastStep, isReady, isConnected, isOverlimit, productsRefreshing, productsSubmitting, productStats:{listed, processing, errors, inactive, total}, orderStats:{total, synced, error, pending}}. productStats counts the listing on the channel; orderStats is present only when order sync is enabled. isOverlimit=true means the product count is above what this Koongo account includes; explain that to the user. productsRefreshing=true means an export / feed generation is running (the integration is 'updating'); productsSubmitting=true means items are being pushed to the channel. While EITHER is true the data is still changing — this is the signal to WAIT: after any export (finishing the wizard summary, repair_marketplace, a step transition that re-exports, or a submit) poll marketplace_status until BOTH productsRefreshing AND productsSubmitting are false, THEN read the results. The KOONGO DATA CHECK (get_marketplace_report's dataCheckErrors) and the productStats counts are only current once the refresh has finished — reading mid-refresh gives stale/empty data. categoryAttributeWarmup is the OTHER wait: on channels whose attributes depend on the mapped categories, that download runs in the background. While the block is present with pending:true the category-driven attributes are NOT in get_marketplace_attributes yet — poll this tool (retryAfterSeconds says how long to wait; state 'rescheduled' means a channel rate limit parked it until nextTryAt) until the block is absent or state is 'ready'. state 'failed' is terminal: call refresh_marketplace_category_attributes ONCE to start it again, do not poll on. marketplace_id is the id from list_marketplaces. project_id is OPTIONAL (inferred for a single-project customer; project_id_required otherwise — then call list_projects). Use marketplace_status for run progress and get_marketplace for configuration/mapping. For the detailed error breakdown use get_marketplace_report.

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

Input Schema

NameRequiredDescriptionDefault
project_idNo
marketplace_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare readOnly/idempotent/non-destructive; the description goes far beyond by explaining that mid-refresh reads return stale or empty data, that isOverlimit means the count exceeds the Koongo account allowance and should be explained to the user, and that orderStats only appears when order sync is enabled. It also discloses the rate-limit state ('rescheduled' with retryAfterSeconds/nextTryAt), which no annotation conveys.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core purpose is front-loaded, but the body is a dense run-on that restates itself ('Use this to check a marketplace's run progress and product counts' duplicates the opening) and crams two separate polling protocols plus a return-shape listing into one paragraph. The content is valuable, but the structure is monolithic and would benefit from splitting wait-signals from field semantics.

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?

With no output schema and a complex polled status tool, the description inlines the full return shape, defines the non-obvious flags (isOverlimit, productsRefreshing, productsSubmitting, categoryAttributeWarmup states), and explains conditional field presence. An agent has everything needed to call it and interpret the response correctly.

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 must carry the load, and it does: marketplace_id is 'the id from list_marketplaces', and project_id is OPTIONAL, inferred for single-project customers but required otherwise — with the recovery path (call list_projects on project_id_required). This removes ambiguity the bare integer schema leaves.

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?

Opens with a specific verb and resource ('Get the live run status of one marketplace') and enumerates the dimensions returned (readiness, connection, product/order counts). It explicitly contrasts itself with siblings: 'Use marketplace_status for run progress and get_marketplace for configuration/mapping. For the detailed error breakdown use get_marketplace_report.'

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?

Gives explicit when-to-use plus alternatives, and even supplies the operating loop: poll until productsRefreshing AND productsSubmitting are both false before reading results, and poll categoryAttributeWarmup until the block is absent or 'ready'. It also states the terminal case ('state failed is terminal: call refresh_marketplace_category_attributes ONCE... do not poll on').

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