Skip to main content
Glama

get_order_overview

Read-onlyIdempotent

The project's ORDER dashboard for standalone order connections (marketplaces managed WITHOUT a product wizard). Use this to see the project's order connections and their sync status. Returns order counts and the project's order connections in one call: {ordersToday, ordersThisMonth, ordersLastMonth, ordersLast12Months, ordersWithError, ordersNotInserted, activeConnectionCount, syncStatus, syncStatusLabel, syncStartedAt, syncedAt, syncMessage, connections:[{connectionId, name, channelCode, channelLabel, channelApiCode, status, orderStatus, orderSyncLevel, authType, hasCredentials, lastSyncStatus, lastSyncAt, lastSyncMessage}]}. orderStatus is 'active'|'disabled'|'not allowed'|'overlimit' (whether that connection is syncing orders). Start here to see order state, then drill into one connection with get_order_connection. A newly added connection appears here once the user finishes authentication in the Koongo UI. Marketplace integrations with order sync are NOT listed here; see marketplace_status. project_id is OPTIONAL (inferred for a single-project customer; 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": "get_order_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Beyond the read-only and idempotent annotations, it explains the combined aggregate and per-connection response, authentication-dependent visibility, and explicit scope exclusion. The project inference and project_id_required behavior further clarify invocation outcomes, with no conflict against the annotations.

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 purpose and routing advice are front-loaded, and the final project_id guidance is compact and actionable. The long inline payload listing makes the single paragraph dense and less scannable, so it is thorough rather than maximally concise.

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, the explicit payload listing and orderStatus enum supply otherwise missing response semantics. Together with scope exclusions, drill-down routing, authentication visibility, and project-selection behavior, the description is complete enough for reliable selection and invocation.

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?

Although the schema provides no description for project_id, the description fully compensates: it is optional for a single-project customer, inferred automatically, and otherwise required with a project_id_required error. It also supplies the concrete recovery action of calling list_projects.

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?

Identifies the resource as a project's ORDER dashboard, limits it to standalone order connections, and states that it provides connections, sync status, and order counts. It also distinguishes the tool from get_order_connection and marketplace_status.

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 an explicit workflow: start here for order state, then use get_order_connection for one connection, and use marketplace_status for marketplace integrations with order sync. It also explains when to call list_projects and when a newly added connection becomes visible.

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