Skip to main content
Glama
mcp-server-ipex

mcp-server-ipex

by Spoje-NET

Get Report Top Customers

get_report_top_customers
Read-onlyIdempotent

Retrieve a ranked list of top IPEX customers from the reports API, letting you set the number returned and the sort order.

Instructions

Top customers. IPEX API: GET /v1/reports/providers/top-customers.

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_report_top_customers"
  }
}

Input Schema

NameRequiredDescriptionDefault
topNoQuery parameter 'top' of the IPEX API.
orderNoQuery parameter 'order' of the IPEX API.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.2/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds only the HTTP verb and route, which hints it is a read-only GET but is redundant with readOnlyHint; it discloses nothing about ranking criteria, defaults, result limits, or whether data is live versus pre-aggregated.

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

Conciseness2/5

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

Two fragments, which is brief but not informative rather than efficient; there is no front-loaded statement of what the report returns. The brevity here reflects under-specification, not disciplined editing.

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?

No output schema exists, so the description should explain what a "top customers" report contains and how results are ranked or limited. Given the tool has two free-form query parameters and a whole family of sibling report tools, the definition leaves an agent unable to predict the response shape or pick this tool confidently.

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 even though the description mentions no parameters. That said, the schema's own text ("Query parameter 'top' of the IPEX API") is tautological, so an agent still cannot tell what 'top' counts or what values 'order' accepts (e.g. asc/desc, or a field name), and the description does nothing to compensate.

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

Purpose2/5

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

"Top customers" is a noun phrase that essentially restates the tool name and title, without stating what makes a customer "top" (revenue, calls, invoices) or what form the report takes. The only added specificity is the raw endpoint path, which helps identify the backing API resource but says nothing about the tool's semantics.

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?

No when-to-use guidance, no exclusions, and no pointer to siblings such as get_report_customers or get_report_provider_customers_count, which an agent would need in order to choose between overlapping customer reports. The endpoint path implies a reporting context but gives no selection criteria.

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