Skip to main content
Glama

sync_project_orders

Start an order synchronization for the whole project now — ONE background process that pulls orders across ALL of the project's order connections at once (the same run as the Koongo 'Sync Now' button; it also overlaps with any marketplace order sync, since order sync runs once per project). Use this when the user wants all order connections synced now. Returns {action:'sync', status:'done', message}; if a sync is already running that run continues (status stays 'done'). This is heavy and project-wide: to check a SINGLE connection use test_order_connection instead. Order counts then move in get_order_overview. project_id is OPTIONAL (project_id_required otherwise — then call list_projects).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sync_project_orders"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idNo

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: it discloses that this is a background process equivalent to the Koongo 'Sync Now' button, that it overlaps with marketplace order sync (once per project), that it is heavy and project-wide, and exactly what happens on re-invocation ('if a sync is already running that run continues'). It also names the return shape ({action,status,message}) despite no output schema, plus the downstream effect ('order counts then move in get_order_overview'). Missing only permission/auth and latency guidance for what is flagged openWorld.

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 action and scope, then behavior, then alternatives — a sensible order. It is dense and parenthetical-heavy, and the phrase 'project_id is OPTIONAL (project_id_required otherwise — then call list_projects)' is slightly garbled, but essentially every clause carries information the agent needs.

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 one-optional-parameter async-style trigger with no output schema, the definition covers scope, side effects, idempotency-on-repeat behavior, the shape of the response, and where results surface afterward. Nothing an agent needs in order to call it correctly and interpret the result is absent.

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%, and the schema is a bare integer, so the description carries the burden — it does so by stating that project_id is OPTIONAL, is required in some contexts, and pointing to list_projects for discovery. That is meaningful semantic addition, though it never states the id's expected origin or that omission implies the default project.

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 ('start an order synchronization for the whole project now') and immediately scopes it as ONE background process covering ALL of the project's order connections. It explicitly separates itself from the nearest sibling ('to check a SINGLE connection use test_order_connection instead'), so an agent can disambiguate without opening a 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?

Gives a direct when-to-use rule ('Use this when the user wants all order connections synced now') and names the exclusion and its substitute ('to check a SINGLE connection use test_order_connection'). It also supplies the fallback path when the project is unset ('project_id_required otherwise — then call list_projects'), which is the kind of routing guidance agents usually have to guess.

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