Skip to main content
Glama
Sign In

Xero

by io.github.pipeworx-io
OverviewDiscussionsAdmin

List Contacts

list_contacts
Read-onlyIdempotent

List contacts (customers and suppliers) from a Xero accounting organisation. Returns name, email, status, and customer/supplier flags. Use for accounting, bookkeeping, and accounts-receivable/payable workflows. Supports Xero filter expressions and pagination.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number for pagination (default 1). Xero returns up to 100 contacts per page.
whereNoOptional Xero filter expression (e.g. 'IsCustomer==true' or 'ContactStatus=="ACTIVE"'). Applied as the Xero `where` query parameter.
tenant_idNoOptional Xero tenant (organisation) id to target. If omitted, the first connected organisation is used. Get ids from list_organisations.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "tenant_id": "12345678-1234-1234-1234-123456789012",
+    "where": "IsCustomer==true"
+  },
+  {
+    "page": 1,
+    "where": "ContactStatus==\"ACTIVE\""
+  }
+]
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint, destructiveHint. Description adds specific return fields and filter/pagination support, enhancing transparency beyond 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 sentences, front-loaded with purpose and output, then usage and capabilities. No filler or redundancy.

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?

All parameters documented, return fields described, use cases provided, and annotations cover safety and idempotency. Output schema not needed for such a list tool.

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 covers all 3 parameters. Description adds context: ties 'where' to Xero filter expressions, mentions pagination for 'page', and advises using list_organisations for tenant_id.

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 clearly states it lists contacts (customers and suppliers) from Xero, specifying returned fields. It distinguishes from sibling tools like list_accounts and list_invoices by focusing on contacts.

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?

Explicitly mentions workflows (accounting, bookkeeping, AR/AP) and capabilities (filter expressions, pagination). No explicit alternatives but sibling tools don't offer contact listing.

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

All Xero 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