Skip to main content
Glama

get_pnl

Read-only

Compute Profit & Loss (P&L / net income / margin) by combining the Income tab with expense tabs. Examples: 'am I profitable this year', 'P&L for Q1', 'net income last quarter', 'what's my margin', 'P&L this year vs last' (YoY). Supports period comparison — YoY, MoM, QoQ, same-month-prev-year. Margin shows as a multiplier in loss (e.g. 'expenses 5.4x revenue'). Returns: { message, data: { revenue, expenses, netIncome, margin, comparison?, sampleMeta? } }.

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

Input Schema

NameRequiredDescriptionDefault
queryNoNatural language P&L question (e.g., 'P&L for Q1 2025', 'am I profitable')
dateRangeNoOne period variant matching user wording.
clientEmailNoAccountants: accepted client email only.

Output Schema

NameRequiredDescriptionDefault
dataNoInline analytics; null without sheet/data.
typeNoAsync analytics_pending: poll pollEndpoint/poll_analytics(jobId).
jobIdNoAsync branch only.
messageNoNarrative.
successNoAsync branch only.
responseNoChat alias of message.
pollEndpointNoAsync branch only.
pollIntervalNoAsync: milliseconds.
estimatedTimeNoAsync: seconds.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedOutput schema / description
      Removed value: -"analytics_pending: poll poll_analytics with jobId; success only here. Inline: message/data, may be null."
    • removedOutput schema / properties / data / additionalProperties
      Removed value: -true
  2. Changed2 schema fields changed
    • changedOutput schema / description
      Previous value: -"Async analytics_pending: jobId, poll poll_analytics; success only here. Inline: message/data (possibly null)."New value: +"analytics_pending: poll poll_analytics with jobId; success only here. Inline: message/data, may be null."
    • removedOutput schema / required
      Removed value: -[]
  3. Changed9 schema fields changed
    • changedInput schema / properties / clientEmail / description
      Previous value: -"Accepted client's account email (accountants only)."New value: +"Accountants: accepted client email only."
    • changedInput schema / properties / dateRange / description
      Previous value: -"Time period filter; use exactly one variant matching the user's phrasing."New value: +"One period variant matching user wording."
    • 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 phrase, e.g. 'last month', 'YTD', '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.",
      +        "type": "string"
      +      },
      +      "type": {
      +        "const": "month",
      +        "type": "string"
      +      },
      +      "year": {
      +        "description": "Four-digit year.",
      +        "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: 'last month', 'YTD', 'last 7 days'.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "type",
      +      "value"
      +    ],
      +    "title": "Relative natural-language range",
      +    "type": "object"
      +  }
      +]
    • changedOutput schema / description
      Previous value: -"Async: type='analytics_pending' with jobId (poll poll_analytics). Inline: message + data (data may be null). success only on the async branch."New value: +"Async analytics_pending: jobId, poll poll_analytics; success only here. Inline: message/data (possibly null)."
    • changedOutput schema / properties / data / description
      Previous value: -"Inline branch: computed analytics, or null when no spreadsheet / no data."New value: +"Inline analytics; null without sheet/data."
    • changedOutput schema / properties / estimatedTime / description
      Previous value: -"Async branch only: seconds."New value: +"Async: seconds."
    • changedOutput schema / properties / message / description
      Previous value: -"Human-readable narrative (both branches)."New value: +"Narrative."
    • changedOutput schema / properties / pollInterval / description
      Previous value: -"Async branch only: milliseconds."New value: +"Async: milliseconds."
    • changedOutput schema / properties / type / description
      Previous value: -"Async branch only: \"analytics_pending\" — poll pollEndpoint or call poll_analytics with jobId."New value: +"Async analytics_pending: poll pollEndpoint/poll_analytics(jobId)."
  4. Changed4 schema fields changed
    • changedInput schema / properties / clientEmail / description
      Previous value: -"Client account email. Accountants may use this only for an accepted ExpenseBot client."New value: +"Accepted client's account email (accountants only)."
    • 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."
  5. 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"
      +}
  6. 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
  7. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered; the description adds real substance beyond them — the data sources combined, the supported comparison modes (YoY/MoM/QoQ/same-month-prev-year), and the unusual margin convention in loss ('expenses 5.4x revenue'). It does not discuss data freshness, empty-data behavior, or sampling (sampleMeta is mentioned but unexplained).

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?

Front-loaded with the core action, then examples, then capabilities, then return shape — a sensible order for a single dense paragraph. The inline return-shape listing is somewhat redundant given an output schema exists, but it is compact and the sentences otherwise carry information.

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

Completeness4/5

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

For a read-only computation with a fully documented schema and an output schema, the description covers sources, period semantics, comparison modes, and margin formatting — enough for correct invocation. Gaps are minor: no guidance on the clientEmail accountant path, no mention of what sampleMeta means, and no statement of behavior when no income/expense data exists.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline would be 3, but the description adds meaning the schema lacks: it makes explicit that the primary input is a natural-language question and that comparative phrasing ('this year vs last') is a supported way to trigger the comparison output. This directly disambiguates how to drive the dateRange/query pairing rather than just repeating field docs.

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

Purpose4/5

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

The description names a specific verb+resource ('Compute Profit & Loss by combining the Income tab with expense tabs') and lists synonym phrasings (P&L, net income, margin), which is more than a restatement. It stops short of naming a sibling (e.g. get_per_tag_pnl or get_income_summary) to differentiate scope, so an agent must infer that this is the aggregate view rather than the per-tag breakdown.

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

Usage Guidelines3/5

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

Usage is conveyed only via example utterances ('am I profitable this year', 'P&L for Q1'), which implies the natural-language entry path but never states when to prefer this over get_per_tag_pnl or get_spending_summary. No exclusions or prerequisites are given, leaving the choice between the several P&L/income siblings to inference.

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.