Skip to main content
Glama

xero_list_budgets

Read-onlyIdempotent

List Xero budgets from your accounting system with the authenticated connector. Retrieve budget data for analysis, reporting, and financial planning.

Instructions

Xero connector operation list_budgets (platform tool xero.list_budgets).

Routes only through the exact project/account governed connector authority.

Args: arguments: JSON string of arguments for the connector operation. project_id: Authenticated Project UUID. project_ref: Exact project correlation reference. connector_account_ref: Project-bound connector account alias. idempotency_key: Stable business-action identity. effect: Required and must be read; Spring verifies it. approval_ref: Approved platform task UUID when resuming a write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
effectYes
argumentsNo{}
project_idNo
project_refNo
approval_refNo
idempotency_keyNo
connector_account_refNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.1.1
    • addedInput schema / properties / approval_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Approval Ref"
      +}
    • addedInput schema / properties / connector_account_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Connector Account Ref"
      +}
    • addedInput schema / properties / effect
      Added value: +{
      +  "const": "read",
      +  "title": "Effect",
      +  "type": "string"
      +}
    • addedInput schema / properties / idempotency_key
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Idempotency Key"
      +}
    • addedInput schema / properties / project_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Project Id"
      +}
    • addedInput schema / properties / project_ref
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Project Ref"
      +}
    • addedInput schema / required
      Added value: +[
      +  "effect"
      +]
  2. First observedv0.1.0

TDQS

C2.8/5.0
Behavior3/5

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

Annotations (readOnlyHint=true, destructiveHint=false, idempotentHint=true) already cover the safety profile, so the bar is lower. The description adds the governed-routing constraint and the enforced effect=read requirement, which are genuinely useful context. However, the approval_ref line ('when resuming a write') is confusing boilerplate inside a read-only tool, and no Xero-specific behavior (pagination, budget scope, boundaries of the list) is disclosed.

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?

The description is compact and scannable: an identity line, a routing line, then a clean Args block. The only waste is the redundancy of naming the operation twice in the first sentence.

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?

The wrapper mechanics (governed authority, effect enforcement, parameter roles) are documented, and an output schema exists so return values are covered. But the core invocation detail is missing: what belongs inside `arguments` to actually list Xero budgets. An agent could select this tool but would not know how to call it correctly, which is the central gap for a thin connector wrapper.

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 0%, so the description must compensate, and it does give a one-line role for all seven parameters (project_id is 'Authenticated Project UUID', effect must be 'read', etc.). But the operation-critical parameter, arguments, is only described as 'JSON string of arguments for the connector operation' with no Xero-specific guidance on what list_budgets accepts, leaving the main payload underspecified.

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

Purpose3/5

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

The first sentence identifies the operation as listing budgets through the Xero connector, so an agent can tell this tool lists budgets. However, that sentence essentially restates the tool name in two forms ('Xero connector operation `list_budgets`' and 'platform tool `xero.list_budgets`'), while the rest is generic platform plumbing. Nothing explains what a budget is here, what the list contains, or how this differs from the sibling xero_get_budget.

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?

The only usage-adjacent statement is 'Routes only through the exact project/account governed connector authority,' which is a governance constraint rather than selection guidance. The description never says when to choose list_budgets over xero_get_budget or xero_budget_summary_report, and it lists no prerequisites or exclusions.

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