Xero MCP Server

🚀 Xero Model Context Protocol (MCP) Server

The Xero MCP Server is a tool for interacting with the Xero accounting system. It provides interfaces through the Model Context Protocol (MCP) specification, supporting the creation, reading, updating, and deletion of various financial and payroll data.

🚀 Quick Start

📦 Installation

# Using npm
npm install

# Using pnpm
pnpm install

Run Build

# Using npm
npm run build

# Using pnpm
pnpm build

Configure Environment Variables

Please ensure that sensitive information (such as the .env file) is not committed to the version control system.

✨ Features

Supported Operations

Query Operations

• list_xero_contacts: Get all contacts.
• list_xero_invoices: Get all invoices.
• list_xero_payments: Get all payment records.
• list_xero_quotes: Get all quotes.
• list_payroll_employees: Get all payroll employee information.
• list_payroll_leave_types: Get all available leave types.

Operation Examples

Query Contacts

curl --location 'http://localhost:3000/api/contacts' \
--header 'Content-Type: application/json'

Create a New Contact

curl --location 'http://localhost:3000/api/contacts' \
--method POST \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "John Doe",
    "email": "john.doe@example.com"
}'

🔧 Technical Details

Project Structure

xero-mcp-server/
├── src/               # Source code directory
│   ├── index.js      # Entry file
│   ├── routes/       # Route definitions
│   └── controllers/  # Controller logic
├── package.json      # Package management file
└── .env.example      # Environment variable example

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.

⚠️ Important Note

Please ensure that API keys and other sensitive information are handled securely in both development and production environments. It is recommended to store this information in environment variables rather than directly in the code or version control system.

⚠️ Important Note

When using this tool, please comply with Xero's terms of service and data privacy policy.

💡 Usage Tip

Contributions are welcome! Please fork the repository and submit a pull request. Ensure that the tests pass before submitting your code.