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"
}'

🔒 安全注意事项

请确保在开发和生产环境中安全地处理 API 密钥和其他敏感信息。建议将这些信息存储在环境变量中，而不是直接写入代码或版本控制系统。

🏗️ 项目结构

xero-mcp-server/
├── src/               # 源代码目录
│   ├── index.js      # 入口文件
│   ├── routes/       # 路由定义
│   └── controllers/  # 控制器逻辑
├── package.json      # 包管理文件
└── .env.example      # 环境变量示例

🤝 贡献指南

欢迎大家贡献代码！请 fork 该仓库并提交 pull request。在提交代码前，请确保通过测试。

📄 许可证

本项目使用 MIT 许可证，具体内容请参考 LICENSE 文件。

⚠️ 重要提示

使用此工具时，请遵守 Xero 的服务条款和数据隐私政策。