Skip to main content
Glama
GeiserX

cashpilot-mcp

by GeiserX
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Go
Hybrid

Earnings history

get_earnings_history
Read-onlyIdempotent

Retrieve earnings records per service and collection over a selected period in USD to track how one service's balance changed.

Instructions

Earnings records per service and collection over a period, in USD. Use it to see how one service's balance moved; for daily totals use get_earnings_daily.

Input Schema

NameRequiredDescriptionDefault
periodYesweek, month, year or all.

Output Schema

NameRequiredDescriptionDefault
earningsYesCashPilot /api/earnings/history

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.3.0
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / period / description
      Previous value: -"Time period: week, month, year, or all"New value: +"week, month, year or all."
    • addedInput schema / properties / period / enum
      Added value: +[
+  "week",
+  "month",
+  "year",
+  "all"
+]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "earnings": {
+      "description": "CashPilot /api/earnings/history",
+      "items": {
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "earnings"
+  ],
+  "type": "object"
+}
  2. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare read-only, idempotent, non-destructive behavior, so the description does not need to restate safety. It adds useful context about currency and grouping, but no operational details such as pagination or response shape; with an output schema present, that is acceptable.

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

Conciseness5/5

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

Two short sentences, no waste, and the main scope/use case is front-loaded before the alternative tool routing.

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 low-complexity, one-parameter, read-only tool with an output schema and full annotation coverage, the description supplies the needed scope, currency, use case, and sibling alternative. Nothing essential for correct invocation is missing.

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%, and the only parameter is a fully described enum. The description adds only the phrase 'over a period' and otherwise defers to the schema, which is the expected baseline when the schema is complete.

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?

The description states a specific resource and scope: earnings records per service and collection over a period, in USD. It also distinguishes this from the daily-totals sibling, so an agent can tell what this tool returns without opening the schema.

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

Usage Guidelines4/5

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

It gives a clear use case ('see how one service's balance moved') and explicitly routes daily totals to get_earnings_daily. It does not mention the other earnings-related siblings, but the primary when-to-use guidance is present.

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