Xero MCP Server

🚀 Xero 模型上下文協議（MCP）服務器

Xero MCP 服務器是一款用於與 Xero 賬務系統交互的實用工具。它藉助模型上下文協議（MCP）規範提供接口，支持對各類財務和 payroll 數據進行創建、讀取、更新和刪除操作，為財務管理提供了便利。

🚀 快速開始

📦 安裝指南

你可以使用以下命令進行安裝：

# 使用 npm
npm install

# 使用 pnpm
pnpm install

運行構建

使用以下命令來運行構建：

# 使用 npm
npm run build

# 使用 pnpm
pnpm build

配置環境變量

請確保不要將敏感信息（如 .env 文件）提交到版本控制系統中。

✨ 主要特性

支持的操作

查詢操作

• list_xero_contacts：獲取所有聯繫人。
• list_xero_invoices：獲取所有發票。
• list_xero_payments：獲取所有付款記錄。
• list_xero_quotes：獲取所有報價單。
• list_payroll_employees：獲取所有 payroll 員工信息。
• list_payroll_leave_types：獲取所有可用的 leave 類型。

操作示例

💻 使用示例

基礎用法

# 查詢聯繫人
curl --location 'http://localhost:3000/api/contacts' \
--header 'Content-Type: application/json'

高級用法

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

🔧 技術細節

項目結構

xero-mcp-server/
├── src/               # 源代碼目錄
│   ├── index.js      # 入口文件
│   ├── routes/       # 路由定義
│   └── controllers/  # 控制器邏輯
├── package.json      # 包管理文件
└── .env.example      # 環境變量示例

📄 許可證

本項目使用 MIT 許可證，具體內容請參考 LICENSE 文件。

⚠️ 重要提示

請確保在開發和生產環境中安全地處理 API 密鑰和其他敏感信息。建議將這些信息存儲在環境變量中，而不是直接寫入代碼或版本控制系統。

⚠️ 重要提示

使用此工具時，請遵守 Xero 的服務條款和數據隱私政策。

💡 使用建議

歡迎貢獻！請 fork 該倉庫並提交 pull request。在提交代碼前，請確保通過測試。