Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

freshbooks_list_payments

Read-only

Fetch payment records from FreshBooks using pagination and raw filter parameters, returning items, page details, and total count.

Instructions

List payments for the authenticated FreshBooks account. Supports pagination and raw FreshBooks filter params. Returns items plus page/pages/total.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo1-based page number
searchNoRaw FreshBooks filter params passed through verbatim, e.g. {"search[customerid]": 123} or {"include[]": "lines"}. Field names are not validated.
per_pageNoResults per page (max 100)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.7.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Changed2 schema fields changedv0.3.1
    • removedInput schema / properties / search / additionalProperties / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "number"
-  },
-  {
-    "type": "boolean"
-  }
-]
    • addedInput schema / properties / search / additionalProperties / type
      Added value: +[
+  "string",
+  "number",
+  "boolean"
+]
  3. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the description does not need to repeat safety. It adds behavioral context by noting pagination support, raw filter passthrough, and the return shape ('items plus page/pages/total'). This goes beyond the annotation and helps the agent understand pagination behavior and response structure.

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 with no extraneous words. The core purpose is front-loaded, followed by key behavioral notes. Every sentence earns its place, and the description is appropriately sized for a list operation.

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?

For a list tool with 3 optional parameters and no output schema, the description covers the essential aspects: pagination, raw filter usage, and return shape. It does not cover error cases or authentication, but those are common across the tool set and annotations cover safety. Minor gaps, but sufficient for correct invocation.

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 each parameter (page, search, per_page) already documented in the schema. The description adds no additional parameter-level meaning beyond the schema, merely summarizing that pagination and raw filters are supported. With high coverage, baseline 3 is appropriate.

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?

The description clearly states the verb 'List' and resource 'payments', specifying the scope as 'for the authenticated FreshBooks account'. It distinguishes from sibling tools like freshbooks_get_payment (single payment) and other list tools by resource type. The phrase 'List payments' is unambiguous and specific.

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

Usage Guidelines3/5

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

The description does not explicitly contrast with alternatives such as freshbooks_get_payment or other list tools. Usage is implied (e.g., listing multiple payments) but no when/when-not guidance or explicit alternative references are given. It is clear enough for an agent to infer use, but lacks explicit routing.

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

Deploy Server

Other Tools