Skip to main content
Glama

get_income_summary

Read-only

Use this when the user asks about income already recorded in their ExpenseBot Income tab. Read totals; group by source, category, month, payment method or tag; filter by dateRange/incomeTagPrefix. Query supports period comparisons (e.g. 'income YTD by source', 'income this year vs last'). Returns message and data with total and optional breakdown, comparison, sampleMeta. No scanning, imports, mutations, tax returns or liability determination.

Input Schema

NameRequiredDescriptionDefault
queryNoNatural language income question (e.g., 'income YTD by source', 'rental income last month')
groupByNoHow to group the breakdown
dateRangeNoTime period filter; use exactly one variant matching the user's phrasing.
incomeTagPrefixNoOptional tag-prefix shortcut (e.g., 'Prop –' for rental income, 'Client –' for client billings, 'Wedding –' for events). When set, the tool filters to income rows tagged with this prefix.

Output Schema

NameRequiredDescriptionDefault
dataNoInline branch: computed analytics, or null when no spreadsheet / no data.
typeNoAsync branch only: "analytics_pending" — poll pollEndpoint or call poll_analytics with jobId.
jobIdNoAsync branch only.
messageNoHuman-readable narrative (both branches).
successNoAsync branch only.
responseNoChat alias of message.
pollEndpointNoAsync branch only.
pollIntervalNoAsync branch only: milliseconds.
estimatedTimeNoAsync branch only: seconds.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / dateRange / description
      Previous value: -"Time period filter. Use exactly one variant — pick the shape that matches the user's phrasing."New value: +"Time period filter; use exactly one variant matching the user's phrasing."
    • changedInput schema / properties / dateRange / oneOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "month": {
      -        "description": "Month name or 1-12 (e.g., 'March' or '3')",
      -        "type": "string"
      -      },
      -      "type": {
      -        "const": "month",
      -        "type": "string"
      -      },
      -      "year": {
      -        "description": "4-digit year (e.g., 2026)",
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "month",
      -      "year"
      -    ],
      -    "title": "Specific month",
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "quarter": {
      -        "maximum": 4,
      -        "minimum": 1,
      -        "type": "integer"
      -      },
      -      "type": {
      -        "const": "quarter",
      -        "type": "string"
      -      },
      -      "year": {
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "quarter",
      -      "year"
      -    ],
      -    "title": "Quarter of a year",
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "type": {
      -        "const": "year",
      -        "type": "string"
      -      },
      -      "year": {
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "year"
      -    ],
      -    "title": "Full year",
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "end": {
      -        "description": "ISO date YYYY-MM-DD (inclusive)",
      -        "format": "date",
      -        "type": "string"
      -      },
      -      "start": {
      -        "description": "ISO date YYYY-MM-DD (inclusive)",
      -        "format": "date",
      -        "type": "string"
      -      },
      -      "type": {
      -        "const": "specific",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "start",
      -      "end"
      -    ],
      -    "title": "Specific date range",
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "type": {
      -        "const": "relative",
      -        "type": "string"
      -      },
      -      "value": {
      -        "description": "Relative range phrase, e.g., 'last month', 'YTD', 'this quarter', 'last 7 days'",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "type",
      -      "value"
      -    ],
      -    "title": "Relative natural-language range",
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "month": {
      +        "description": "Month name or 1-12 (e.g., 'March' or '3')",
      +        "type": "string"
      +      },
      +      "type": {
      +        "const": "month",
      +        "type": "string"
      +      },
      +      "year": {
      +        "description": "4-digit year (e.g., 2026)",
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "month",
      +      "year"
      +    ],
      +    "title": "Specific month",
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "quarter": {
      +        "maximum": 4,
      +        "minimum": 1,
      +        "type": "integer"
      +      },
      +      "type": {
      +        "const": "quarter",
      +        "type": "string"
      +      },
      +      "year": {
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "quarter",
      +      "year"
      +    ],
      +    "title": "Quarter of a year",
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "type": {
      +        "const": "year",
      +        "type": "string"
      +      },
      +      "year": {
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "year"
      +    ],
      +    "title": "Full year",
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "end": {
      +        "description": "ISO date YYYY-MM-DD (inclusive)",
      +        "format": "date",
      +        "type": "string"
      +      },
      +      "start": {
      +        "description": "ISO date YYYY-MM-DD (inclusive)",
      +        "format": "date",
      +        "type": "string"
      +      },
      +      "type": {
      +        "const": "specific",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "start",
      +      "end"
      +    ],
      +    "title": "Specific date range",
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "type": {
      +        "const": "relative",
      +        "type": "string"
      +      },
      +      "value": {
      +        "description": "Relative phrase, e.g. 'last month', 'YTD', 'last 7 days'",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "value"
      +    ],
      +    "title": "Relative natural-language range",
      +    "type": "object"
      +  }
      +]
    • changedOutput schema / description
      Previous value: -"Two branches. Async: type='analytics_pending' with jobId — poll poll_analytics until complete. Inline: message + data with the computed analytics (data may be null when there is no spreadsheet or no data yet). success is present only on the async branch."New value: +"Async: type='analytics_pending' with jobId (poll poll_analytics). Inline: message + data (data may be null). success only on the async branch."
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "description": "Two branches. Async: type='analytics_pending' with jobId — poll poll_analytics until complete. Inline: message + data with the computed analytics (data may be null when there is no spreadsheet or no data yet). success is present only on the async branch.",
      +  "properties": {
      +    "data": {
      +      "additionalProperties": true,
      +      "description": "Inline branch: computed analytics, or null when no spreadsheet / no data.",
      +      "type": [
      +        "object",
      +        "null"
      +      ]
      +    },
      +    "estimatedTime": {
      +      "description": "Async branch only: seconds.",
      +      "type": "number"
      +    },
      +    "jobId": {
      +      "description": "Async branch only.",
      +      "type": "string"
      +    },
      +    "message": {
      +      "description": "Human-readable narrative (both branches).",
      +      "type": "string"
      +    },
      +    "pollEndpoint": {
      +      "description": "Async branch only.",
      +      "type": "string"
      +    },
      +    "pollInterval": {
      +      "description": "Async branch only: milliseconds.",
      +      "type": "number"
      +    },
      +    "response": {
      +      "description": "Chat alias of message.",
      +      "type": "string"
      +    },
      +    "success": {
      +      "description": "Async branch only.",
      +      "type": "boolean"
      +    },
      +    "type": {
      +      "description": "Async branch only: \"analytics_pending\" — poll pollEndpoint or call poll_analytics with jobId.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [],
      +  "type": "object"
      +}
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "description": "Standard ExpenseBot tool result envelope. `message` is the human-readable summary the AI cites; `data` is the structured payload (totals, breakdowns, ids, etc.). On failure, `success` is false and `error` carries a code/message/hint triple.",
      -  "properties": {
      -    "data": {
      -      "additionalProperties": true,
      -      "description": "Structured payload. Shape varies per tool — common keys: total, breakdown, comparison, sampleMeta, ids, expenseId, reportId, signupUrl, results.",
      -      "type": "object"
      -    },
      -    "error": {
      -      "additionalProperties": true,
      -      "description": "Present only when success === false.",
      -      "properties": {
      -        "code": {
      -          "type": "string"
      -        },
      -        "hint": {
      -          "type": "string"
      -        },
      -        "message": {
      -          "type": "string"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "message": {
      -      "description": "Human-readable result text. Always present on success; prefer rendering this verbatim before any further reasoning.",
      -      "type": "string"
      -    },
      -    "sampleMeta": {
      -      "additionalProperties": true,
      -      "description": "Set when the underlying dataset was truncated. isTruncated=true means the agent saw a sample of `sampleCount` of `totalCount` rows; aggregate totals are still accurate.",
      -      "properties": {
      -        "isTruncated": {
      -          "type": "boolean"
      -        },
      -        "sampleCount": {
      -          "type": "integer"
      -        },
      -        "totalCount": {
      -          "type": "integer"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "success": {
      -      "description": "False on tool errors; check before reading `data`.",
      -      "type": "boolean"
      -    }
      -  },
      -  "type": "object"
      -}New value: +null
  4. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the readOnly and non-destructive annotations, the description discloses that it returns message/data with total plus optional breakdown, comparison and sampleMeta. It also states what the tool does not do: scanning, imports, mutations, tax returns and liability determination, which is useful behavioral context.

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?

The description is front-loaded with the usage trigger and then packs purpose, parameters, return shape and exclusions into a short paragraph. Each clause carries information and there is little repetition.

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 annotations and an output schema present, the description supplies enough context about when to call it, what it returns and what it explicitly does not do. An agent can invoke it correctly without additional documentation.

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 schema already documents all four parameters, including the dateRange variants and groupBy enum. The description reinforces the groupBy dimensions and filters but adds no syntax or interaction detail beyond the schema, so the baseline 3 applies.

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 verb and resource: it reads income totals from the ExpenseBot Income tab. It clearly separates this from scanning, importing, mutating, tax-return and liability work, so an agent can distinguish it from siblings such as add_income or scan_gmail.

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 an explicit trigger ('Use this when the user asks about income already recorded...') and exclusions ('No scanning, imports, mutations...'). It does not name alternative tools for adjacent tasks such as expense summaries or recording income, so it falls just short of full 5-level guidance.

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.