Ledgerbackup

io.github.CloudCorpRecords由 GitHub 帳號 CloudCorpRecords 發布v0.1.0更新於 Nov 5, 2026

Read-only backup and export of Xero accounting data: organisations, exports, manifests, downloads.

已驗證STDIO僅桌面檔案與儲存金融

概覽

AI 產生的概覽

連接託管 Boxkite 服務的本機橋接,讓助理列出已連結的會計組織,並以唯讀方式匯出其資料。

可以做什麼
  • 列出 Boxkite 帳戶下已連結的會計組織(Xero、Sage、Reckon、QuickBooks)
  • 為某個組織啟動唯讀匯出,並列出歷史匯出紀錄
  • 查詢匯出的狀態、進度與建議的輪詢間隔
  • 檢視進行中匯出的清單:包含的實體、紀錄與檔案數量、校驗碼
  • 把已發現的檔案對應到其所屬的會計物件
  • 取得已完成 ZIP 的短期簽章下載連結
適用情境
適合讓助理備份或擷取已連結的 Xero、Sage、Reckon 或 QuickBooks 組織中的會計資料,並一路追蹤匯出直到取得可下載的壓縮檔,不必離開對話。
執行需求
透過 npx 或 Docker 在本機執行,並連網把呼叫轉送到託管的 Boxkite 端點。選用環境變數 BOXKITE_MCP_URL 可覆寫端點;選用 BOXKITE_API_KEY 會以 X-API-Key 標頭送出。清單未宣告任何憑證,未設定該變數時不會送出金鑰標頭。
安裝前請注意
啟動匯出每個組織收費 39 美元,需在瀏覽器完成 Stripe 結帳;重複呼叫會回傳既有匯出,不會再次扣款。匯出可能持續數小時,壓縮檔從數 MB 到數 GB 不等。下載連結為短期有效,並受 7 天保留期限制。工具呼叫與參數會轉送給第三方 Boxkite 服務,若設定了 API 金鑰,每次請求都會附帶。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 Ledgerbackup,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

ledgerbackup

ledgerbackup is a small local bridge to the hosted Boxkite MCP server, which backs up and exports accounting data from the organisations connected to your Boxkite account (Xero, Sage, Reckon, or QuickBooks). It lists those organisations, starts a read-only export of one organisation's data, and then tracks that export through its status, manifest and file-to-object mapping until a signed download URL for the finished ZIP is available.

The bridge keeps no accounting data of its own. It serves the upstream server's tool list locally, exactly as captured from the live endpoint, and forwards each tool call upstream, returning the result untouched.

Tools

  • list_organisations — list the accounting organisations connected to the authenticated Boxkite account. No arguments.
  • start_export — start a read-only export of one organisation's data. Required: organisationId (from list_organisations). Per the upstream description, an export costs $39 per organisation: when payment is outstanding the response is status awaiting_payment with a Stripe checkout URL, and repeat calls return the existing export rather than creating or charging for a second one. A typical export runs for hours.
  • list_exports — list one-off exports, newest first, optionally filtered by organisationId. Side-effect free: it never starts an export or charges anything.
  • get_export_status — report one export's state (queued | running | ready | failed), its progress, and when to poll again. Required: exportId.
  • get_export_manifest — see what an in-progress export contains so far, paged via fileOffset and fileLimit. Required: exportId.
  • get_export_mapping — for an in-progress export, map each discovered file to the accounting object it represents, paged the same way. Required: exportId.
  • get_download_url — return a short-lived signed URL for the finished export ZIP, valid within the export's 7-day retention window. Required: exportId.

Configuration

  • BOXKITE_MCP_URL (optional) — override the upstream endpoint. Defaults to https://app.getboxkite.com/mcp. (The override hook is this rebuild's own labelled reconstruction.)
  • BOXKITE_API_KEY (optional) — when set, every upstream request carries an X-API-Key: <key> header with your Boxkite API key. When it is not set, no key header is sent. No Authorization header is ever sent. (This forwarding is also a labelled reconstruction; the original surface was captured keyless.)

Forwarding mechanics

On the first tool call the client opens a streamable HTTP session with the upstream: a JSON-RPC initialize request (protocolVersion 2025-03-26, clientInfo name ledgerbackup), then a notifications/initialized notification, then the tools/call request carrying the caller's arguments unchanged. When the upstream answers initialize with an Mcp-Session-Id header, that value rides on every later request of the session, which is reused for the life of the process. Replies may arrive as plain JSON or as server-sent events; both are read.

Successful upstream results pass through verbatim, including any isError flag the upstream sets. Failures — a JSON-RPC error, a non-2xx status, an unreadable response, or a request that cannot be completed — come back as an isError result whose text starts with ledgerbackup error: (this rendering is this rebuild's own labelled reconstruction).

CLI

Each tool is also a subcommand taking one JSON argument string:

bash
npx @reneturcios/ledgerbackup list_organisationsnpx @reneturcios/ledgerbackup start_export '{"organisationId":"org-123"}'npx @reneturcios/ledgerbackup get_export_status '{"exportId":"exp-9"}'npx @reneturcios/ledgerbackup get_download_url '{"exportId":"exp-9"}'npx @reneturcios/ledgerbackup --version

Exit codes: 0 on success, 1 on an isError result, 2 on a usage error.

MCP server

bash
npx -y @reneturcios/ledgerbackup mcp

MCP client config:

json
{  "mcpServers": {    "ledgerbackup": {      "command": "npx",      "args": ["-y", "@reneturcios/ledgerbackup", "mcp"]    }  }}

Docker

bash
docker run -i ghcr.io/cloudcorprecords/ledgerbackupdocker run --rm ghcr.io/cloudcorprecords/ledgerbackup --version

The container's default command is mcp, so the first form is a stdio MCP server; any other arguments reach the CLI normally.

Development

bash
npm installnpm run buildnpm testnpm run dev

The test suite runs entirely against a stubbed JSON-RPC upstream — no live network calls.

License

MIT — see LICENSE.

來源:README.md,提交 9b4133b

工具

7

list_organisations

List accounting organisations

List the accounting organisations (Xero, Sage, Reckon, or QuickBooks) connected to the authenticated Boxkite account.

無需輸入參數。

start_export

Start a one-off accounting data export

Starts a read-only export of one accounting organisation's data (Xero, Sage, Reckon, or QuickBooks). Costs $39 per organisation: when payment is outstanding the response is status 'awaiting_payment' with a Stripe checkoutUrl for the user to complete in a browser, and the export begins once that payment settles. This is not a status endpoint: it reports only the state at creation, and repeat calls return the existing export for that organisation rather than creating or charging for a second one. Export progress is reported by get_export_status, and newly created exports appear in list_exports. A typical export runs for hours, and pauses whenever it meets a provider rate limit or Boxkite's egress budget — anything from under a minute to the next UTC day. get_export_status reports when it resumes.

輸入參數organisationId必填

list_exports

List exports

List one-off exports (newest first), optionally for one organisation. Use this to find an export after payment and to poll its status until it is 'ready'. Side-effect free: it never starts a new export or charges anything. Each entry carries progress, parkedUntil and pollAfterSeconds.

輸入參數organisationId

get_export_status

Get export status

Reports the state of one export: status (queued | running | ready | failed) and whether its download is available yet. Also returns progress {discovered, transferred, percent}; parkedUntil; and pollAfterSeconds, the interval after which this status is expected to have changed. A large export runs for hours, so pollAfterSeconds can be a long interval. parkedUntil is a timestamp, present whenever work on the organisation is paused and expected to resume. How long varies by cause and is not worth guessing at: hitting Xero's per-minute limit pauses for under a minute, approaching its daily quota pauses for about an hour, and exhausting the daily quota or Boxkite's own egress budget pauses until the next UTC day. Wait until the timestamp (or pollAfterSeconds, which already accounts for it) rather than describing a cause to the user.

輸入參數exportId必填

get_export_manifest

Get export manifest

See what an IN-PROGRESS export contains so far (entities included, per-entity record/file counts, and per-file checksums), growing as discovery and downloading proceed. The per-file list is paged: check filesPage.hasMore and pass fileOffset to walk it. Once the export finishes, this returns status 'complete' with a pointer instead of a list, because the full manifest travels inside the ZIP as manifest.json: get a download URL, then read manifest.json from the archive.

輸入參數exportId必填fileLimitfileOffset

get_export_mapping

Get export file→object mapping

For an IN-PROGRESS export, get the mapping of each file discovered so far to the accounting object it represents or is attached to (e.g. which invoice a receipt PDF belongs to). Paged (default 200 files, max 500): check filesPage.hasMore and pass fileOffset for the next page; the `objects` map covers only the files on the current page. Once the export finishes, this returns status 'complete' with a pointer instead: the full mapping ships under Info/ inside the ZIP, so download the archive and read Info/files.json from it.

輸入參數exportId必填fileLimitfileOffset

get_download_url

Get export download URL

Returns a short-lived signed URL for the export ZIP, valid within the export's 7-day retention window, along with byteSize (the archive's size in bytes, null if unavailable) and fileCount. These archives range from a few MB to several GB. The archive contains the exported files plus manifest.json (every file with its sha256) and Info/ (the file-to-Xero-object mapping).

輸入參數exportId必填

版本歷史

1
  1. v0.1.0最新Nov 5, 2026

評分

已滿足適用檢查項的 90%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分
  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分