Skip to main content
Glama

xero_list_payroll_au_employee_leave_balances

Read-onlyIdempotent

List Australian payroll employee leave balances from Xero through a governed connector. Retrieve current leave accruals and entitlements for payroll review.

Instructions

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

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.3/5.0
Behavior3/5

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

Annotations already establish readOnly, idempotent, and non-destructive behavior. The description adds useful context that effect must be 'read' and that calls route only through a governed connector authority. It does not go further to describe response behavior, required connector state, or external side effects, but for an already-annotated read-only tool the added governance and effect details justify a moderate score.

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

Conciseness3/5

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

The description is reasonably sized and uses a readable Args list, but the first sentence repeats the operation name and the parameter list contains generic fields with boilerplate explanations. It is not bloated, yet it front-loads an identity statement rather than a functional summary.

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?

With 7 parameters, 0% schema coverage, and an external connector, the description is incomplete: it omits the semantics of the operation, the accepted arguments schema, the distinction from sibling Xero payroll list tools, and any connector permission or configuration expectations. An output schema exists, so return shape is covered, but invocation-level knowledge is largely missing.

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

Parameters2/5

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

Schema description coverage is 0%, so the description carries the burden. It labels each framework parameter (project_id, project_ref, connector_account_ref, idempotency_key, effect, approval_ref), but the critical 'arguments' parameter is only defined as 'JSON string of arguments for the connector operation' with no indication of which Xero fields are accepted or required. This does not give an agent enough information to construct a correct operation-specific payload.

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

Purpose2/5

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

The description only restates the operation name ('Xero connector operation list_payroll_au_employee_leave_balances') and adds routing/governance boilerplate; it never states plainly that this tool lists AU payroll employee leave balances or what the returned data represents. An agent must infer purpose entirely from the tool name and sibling taxonomy, which makes this closer to a tautology than a functional definition.

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?

No when-to-use guidance is provided. The description does not distinguish this from near-siblings such as xero_list_payroll_au_employee_leave or xero_list_payroll_au_leave_periods, nor does it state prerequisites such as AU payroll being configured or an employee ID being required. 'Routes only through the exact project/account governed connector authority' is an access constraint, not a usage guideline.

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