关键词

Xero会计软件API集成财务管理业务自动化

Xero MCP Server 使用说明

项目简介

Xero MCP Server 是一个 Model Context Protocol (MCP) 服务器的实现，专为 Xero 云会计软件设计。它充当 LLM 客户端和 Xero API 之间的桥梁，使得 LLM 能够通过标准化的 MCP 协议安全、便捷地访问和操作 Xero 中的数据和功能。通过此服务器，LLM 可以执行诸如读取联系人、创建发票、查询账户等操作，从而扩展 LLM 在商业和会计领域的应用能力。

主要功能点

  • Xero OAuth2 认证: 支持通过 Xero OAuth2 协议进行身份验证，安全访问 Xero API。
  • 联系人管理: 提供创建、更新和列出 Xero 联系人的工具。
  • 发票管理: 支持创建、更新和列出发票，包括草稿发票。
  • 账户管理: 允许列出 Xero 账户信息。
  • 税务管理: 可以获取 Xero 中配置的税率列表。
  • 报价管理: 支持创建和列出报价单。
  • 贷项票据管理: 提供创建和列出贷项票据的功能。
  • 符合 MCP 协议: 完全遵循 Model Context Protocol 规范，确保与 MCP 客户端的兼容性。

安装步骤

  1. 安装 Node.js: 确保你的系统已安装 Node.js (v18 或更高版本) 和 npm 或 pnpm 包管理器。
  2. 克隆仓库: 将 'xero-mcp-server' 仓库克隆到本地。 
    git clone https://github.com/XeroAPI/xero-mcp-server.git
cd xero-mcp-server
  3. 安装依赖: 在仓库根目录下运行以下命令安装项目依赖。 
    # 使用 npm
npm install

# 或使用 pnpm
pnpm install
  4. 构建项目: 运行以下命令构建项目，生成可执行的 JavaScript 文件。 
    # 使用 npm
npm run build

# 或使用 pnpm
pnpm build
  5. 配置 Xero 开发者账号:
    • 访问 Xero Developer 并创建一个开发者账号。
    • 创建一个 Custom Connection 应用，并获取 'Client ID' 和 'Client Secret'。
    • 配置 Custom Connection 的 scopes，至少需要包含 'accounting.transactions accounting.contacts accounting.settings.read'。

服务器配置

要将 Xero MCP Server 集成到 MCP 客户端（例如 Claude Desktop），你需要配置客户端的 MCP 服务器设置。以下是 Claude Desktop 的配置示例，你需要将此 JSON 配置添加到 'claude_desktop_config.json' 文件中：

{
  "mcpServers": {
    "xero": {
      "command": "node",
      "args": ["/path/to/xero-mcp-server/dist/index.js"],
      "env": {
        "XERO_CLIENT_ID": "your_client_id_here",
        "XERO_CLIENT_SECRET": "your_client_secret_here"
      }
    }
  }
}

配置参数说明:

  • server name: 'xero' - 服务器名称，可以自定义，用于在 MCP 客户端中标识该服务器。
  • command: 'node' - 启动服务器的命令，这里使用 Node.js 运行 JavaScript 文件。
  • args: '["/path/to/xero-mcp-server/dist/index.js"]' - 命令参数，指向编译后的服务器入口文件 'dist/index.js' 的绝对路径。请务必替换 '/path/to/xero-mcp-server' 为你本地仓库的实际路径。
  • env: '{ "XERO_CLIENT_ID": "your_client_id_here", "XERO_CLIENT_SECRET": "your_client_secret_here" }' - 环境变量配置，用于传递 Xero API 凭据。请将 'your_client_id_here' 和 'your_client_secret_here' 替换为你从 Xero 开发者账号获取的 Client ID 和 Client Secret。

注意: 请确保 'dist/index.js' 文件的路径正确，并且环境变量配置了有效的 Xero API 凭据。

基本使用方法

  1. 启动 MCP 客户端: 启动配置了 Xero MCP Server 的 MCP 客户端（例如 Claude Desktop）。

  2. 连接到 Xero MCP Server: 客户端应该能够自动连接到配置的 MCP 服务器。

  3. 使用工具: 通过 MCP 客户端，你可以调用 Xero MCP Server 提供的工具来操作 Xero 数据。可用的工具命令包括：

    • 'list-contacts': 列出 Xero 中的联系人。
    • 'list-invoices': 列出发票。
    • 'list-accounts': 列出账户。
    • 'list-tax-rates': 列出税率。
    • 'list-quotes': 列出报价单。
    • 'list-credit-notes': 列出贷项票据。
    • 'create-contact': 创建新的联系人。
    • 'create-invoice': 创建新的发票。
    • 'create-quote': 创建新的报价单。
    • 'create-credit-note': 创建新的贷项票据。
    • 'update-contact': 更新联系人信息。
    • 'update-invoice': 更新发票信息（仅限草稿状态）。

    具体工具的使用方法和参数，请参考每个工具的详细描述或 MCP 客户端的界面提示。

例如，在 Claude 中，你可以通过自然语言指令指示 Claude 调用相应的工具，例如 "列出所有 Xero 联系人" 或 "创建一个名为 'New Customer' 的联系人"。 Claude 将会调用 'list-contacts' 或 'create-contact' 工具，并返回 Xero MCP Server 的执行结果。

信息

分类

商业系统

访问项目