使用说明
项目简介
本项目是 Xero 会计软件的 MCP 服务器实现,旨在通过 Model Context Protocol (MCP) 协议,为大型语言模型 (LLM) 客户端提供访问 Xero 会计数据的能力。它允许 LLM 通过标准化的方式调用 Xero 的各项财务功能,例如查询账户列表、获取发票信息、生成财务报表等,从而扩展 LLM 在财务领域的应用场景。
主要功能点
- OAuth2 认证: 支持通过 OAuth2 协议安全认证 Xero 账户。
- 财务数据访问工具: 提供多种工具,可以访问 Xero 中的会计数据,包括:
- 账户列表查询
- 银行交易记录查询
- 联系人信息查询
- 发票信息查询
- 日记账查询
- 组织信息查询
- 付款记录查询
- 报价单查询
- 资产负债表查询
- 可扩展性: 工具化的设计方便未来扩展更多 Xero 相关的功能。
安装步骤
- 安装 Node.js: 确保您的系统已安装 Node.js 运行环境 (建议使用最新 LTS 版本)。您可以访问 https://nodejs.org 下载安装。
- 安装 Claude Desktop: 如果您计划将此 MCP 服务器与 Claude 客户端一起使用,请确保已安装 Claude Desktop 应用程序。您可以访问 https://claude.ai/download 下载。
- 创建 Xero OAuth2 应用:
- 访问 https://developer.xero.com/app/manage/,登录您的 Xero 开发者账号 (没有账号需要先注册)。
- 点击 "New app" (创建新应用)。
- 填写应用名称 (例如: Xero MCP Server)。
- 选择 "Web app" (Web 应用)。
- 提供一个有效的 URL 作为应用网站 (例如: https://www.example.com)。
- 设置 Redirect URI (重定向 URI) 为 'http://localhost:5000/callback'。
- 勾选同意条款和条件,点击 "Create app" (创建应用)。
- 在应用配置页面左侧选择 "Configuration" (配置)。
- 点击 "Generate a secret" (生成密钥),获取 Client ID 和 Client Secret。
服务器配置
要将此 MCP 服务器配置到 MCP 客户端(例如 Claude),您需要提供服务器的启动命令和相关参数。以下是 'claude_desktop_config.json' 文件的配置示例,请根据您的实际情况修改:
{ "mcpServers": { "xero-mcp": { "command": "npx", "args": ["-y", "xero-mcp@latest"], "env": { "XERO_CLIENT_ID": "YOUR_CLIENT_ID", // 替换为您在 Xero 开发者应用中获取的 Client ID "XERO_CLIENT_SECRET": "YOUR_CLIENT_SECRET", // 替换为您在 Xero 开发者应用中获取的 Client Secret "XERO_REDIRECT_URI": "http://localhost:5000/callback" // OAuth2 重定向 URI,保持与 Xero 应用配置一致 } } } }
配置参数说明:
- 'server name': 'xero-mcp' (服务器名称,客户端用此名称识别和连接服务器)
- 'command': 'npx' (Node.js 包执行器,用于运行 npm 包)
- 'args': '["-y", "xero-mcp@latest"]' (运行 'xero-mcp' npm 包的命令,'@latest' 表示使用最新版本)
- 'env': 环境变量配置,包含连接 Xero API 必需的认证信息:
- 'XERO_CLIENT_ID': Xero 应用的 Client ID
- 'XERO_CLIENT_SECRET': Xero 应用的 Client Secret
- 'XERO_REDIRECT_URI': Xero 应用配置的重定向 URI
基本使用方法
- 重启 MCP 客户端: 修改 'claude_desktop_config.json' 文件后,您需要重启 MCP 客户端 (例如 Claude Desktop) 使配置生效。
- 客户端调用工具: 在 MCP 客户端中,您可以像调用其他工具一样调用此 MCP 服务器提供的工具。首次调用 Xero 相关工具时,会自动弹出 Xero 授权页面,您需要完成 OAuth2 授权流程以连接您的 Xero 账户。授权成功后,即可使用各项 Xero 数据访问工具。
注意: 首次使用 Xero 工具时,需要进行 OAuth2 授权。请务必仔细阅读 Xero 授权页面的权限说明,并谨慎授权。建议在测试环境中使用 Xero 演示公司进行测试,避免影响您的实际财务数据。
信息
分类
商业系统