Skip to main content
Glama
mcp-server-ipex

mcp-server-ipex

by Spoje-NET

Get Report Customer Invoices Sum

get_report_customer_invoices_sum
Read-onlyIdempotent

Calculates the total invoice amount for a specific customer at a given month offset, helping you retrieve customer billing totals from IPEX reports.

Instructions

Sum of invoices of a customer. IPEX API: GET /v1/reports/customers/{customerId}/invoices/sum/{monthOffset}.

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": {
      "customerId": "<customerId>",
      "monthOffset": "<monthOffset>"
    },
    "name": "get_report_customer_invoices_sum"
  }
}

Input Schema

NameRequiredDescriptionDefault
customerIdYesPath parameter 'customerId' of the IPEX API.
monthOffsetYesPath parameter 'monthOffset' of the IPEX API.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.6/5.0
Behavior2/5

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

The annotations already declare readOnlyHint, idempotentHint, non-destructive and openWorld, so the safety profile is fully covered without the description. The description adds only the raw endpoint string; it says nothing about what the aggregate covers, whether results are scoped to a billing period, or how an out-of-range month offset behaves.

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?

Two short sentences with no filler, and the resource statement is front-loaded ahead of the endpoint reference. The endpoint suffix is mildly redundant with the schema but aids traceability, so the brevity does not cost clarity here.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a simple read-only two-parameter report, yet the definition never states what the sum is denominated in or returned as, and there is no output schema to fall back on. The monthOffset contract, the single genuinely ambiguous input, is left entirely unexplained.

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

Parameters3/5

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

Schema description coverage is 100%, so the baseline is 3, but the schema text is purely circular ("Path parameter 'customerId' of the IPEX API") and the description does not compensate. In particular the format and unit of monthOffset - the one parameter whose meaning is non-obvious - remain undefined anywhere in the definition.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Sum of invoices of a customer" names a specific resource but leaves the operation ambiguous - it is unclear whether the sum is a monetary total, a count, or an aggregate over the month window. The API route clarifies the resource path but not the semantic of the returned sum, and nothing distinguishes it from siblings such as list_invoices, get_invoices_by_payment_type, or get_report_customer_requests_count.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no stated prerequisites, and no mention of alternatives. An agent cannot tell from the definition whether to call this versus listing invoices and summing them, or versus the other customer report tools in the catalog.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools