Skip to main content
Glama

stub

by africa.stub.api
OverviewDiscussionsAdmin

List income

list_income
Read-only

List the business's income entries with amount, date, category account and linked bank transaction. These are recorded income entries; for the sales documents behind them use list_invoices, and for raw bank-feed lines use list_transactions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toNoOnly rows on/before this date (ISO 8601). Rows without a date are kept.
maxNoOnly rows whose amount is at most this (inclusive). Rows with no amount are excluded when min/max is set.
minNoOnly rows whose amount is at least this (inclusive). Rows with no amount are excluded when min/max is set. Applied before pagination.
fromNoOnly rows on/after this date (ISO 8601, e.g. "2026-01-01"). Rows without a date are kept.
limitNoMax rows to return in this page (default 50). Responses include next_cursor / truncated / total; pass next_cursor back as `cursor` to fetch the next page. Never silently truncated.
queryNoCase-insensitive substring filter — keeps only rows whose text (name, notes, and other string fields) contains this. Applied before pagination, so total/next_cursor reflect the filtered set.
cursorNoOpaque pagination cursor. Omit for the first page; pass the next_cursor from a previous response verbatim to fetch the next page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes that this is a safe read operation. The description adds useful scope boundaries ('recorded income entries' vs. invoices/raw bank lines) but does not disclose further behavioral traits such as ordering, authorization needs, or what guarantees the API provides. No contradiction with annotations.

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 purposeful sentences with no filler. The first states the resource and its key fields; the second routes to the relevant siblings. Essential differentiators are front-loaded.

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 read-only list tool, the description plus the fully documented input schema and annotation is complete: it identifies what is listed, how it differs from related tools, and the schema covers all filter and pagination semantics. The limit parameter even documents response fields like next_cursor/truncated/total, compensating for the lack of an output schema.

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 each parameter already has a detailed semantic description covering date handling, min/max inclusion rules, substring filtering, and pagination cursor mechanics. The prose description adds no parameter-level details, but with full schema coverage this is acceptable.

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 ('List the business's income entries'), enumerates the returned fields (amount, date, category account, linked bank transaction), and explicitly distinguishes itself from list_invoices and list_transactions. An agent can determine exactly what this tool does 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 Guidelines5/5

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

Explicitly names alternatives and the conditions for choosing them: use list_invoices for the sales documents behind income entries and list_transactions for raw bank-feed lines. This gives an unambiguous routing rule for an agent comparing sibling tools.

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

All stub toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources