Skip to main content
Glama
honeybook-mcp

honeybook-mcp

by chrischall

list_payments

Read-only

Retrieve a HoneyBook workspace's payment schedule, including each file's amount, due date, paid/pending status, payment method, invoice number, and per-currency paid/unpaid totals.

Instructions

Payment schedule for a workspace — the portal's Payments tab: each file's payments with amount, due date, paid/pending state, how it was paid and the invoice number, plus paid/unpaid totals per currency. To pay one, use pay_invoice.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace_id": "<workspace_id>"
    },
    "name": "list_payments"
  }
}

Input Schema

NameRequiredDescriptionDefault
viewNo"full" (default): the files, payments and per-currency totals. "brief": one line per payment — file: description (amount) — due <ISO date or "no date"> — <paid|pending|overdue|unpaid>, inside the untrusted-data envelope as data: string[]; "-- none" when there is no payment.
originNoPortal origin (e.g. https://<vendor>.hbportal.co). Optional when only one session is active, or when workspace_id is a listed project name.
workspace_idYesThe workspace _id (from list_projects).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.1
    • changedInput schema / properties / origin / description
      Previous value: -"Portal origin (e.g. https://<vendor>.hbportal.co). Optional when only one session is active."New value: +"Portal origin (e.g. https://<vendor>.hbportal.co). Optional when only one session is active, or when workspace_id is a listed project name."
    • addedInput schema / properties / view
      Added value: +{
      +  "description": "\"full\" (default): the files, payments and per-currency totals. \"brief\": one line per payment — file: description (amount) — due <ISO date or \"no date\"> — <paid|pending|overdue|unpaid>, inside the untrusted-data envelope as data: string[]; \"-- none\" when there is no payment.",
      +  "enum": [
      +    "full",
      +    "brief"
      +  ],
      +  "type": "string"
      +}
  2. Changed1 schema field changedv1.0.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. Addedv0.9.0

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds substantive behavioral context beyond that: it discloses the exact payload contents (per-file payments, per-currency paid/unpaid totals) and the paid/pending state model, which is what an agent needs to interpret results. It stops short of noting session/auth requirements or result size, keeping it at a 4.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with the resource and its contents, followed by the routing hint. No redundant restatement of the name or title, and every clause carries information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the return-value burden and does so well by enumerating the fields and totals returned. It is nearly complete for a read-only listing tool; only minor operational details (pagination, empty-result behavior) are absent, and the schema covers the empty case for brief view.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with view, origin, and workspace_id all documented in the schema itself, including the enum semantics for view. The description adds no parameter-level meaning beyond that, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific resource (payment schedule for a workspace) and enumerates the returned fields — amount, due date, paid/pending state, payment method, invoice number, per-currency totals — and explicitly names the sibling it is not (pay_invoice). An agent can distinguish it from list_payment_methods and pay_invoice without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly routes the write action to pay_invoice ("To pay one, use pay_invoice"), giving a clear alternative. It does not state exclusions or prerequisites (e.g. that a session must be active), but the core when-to-use guidance is present and unambiguous.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.