Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

freshbooks_list_records

Read-only

List any FreshBooks accounting resource by name, covering taxes, credit notes, bills, and other record types. Returns paginated items with totals.

Instructions

List any FreshBooks accounting resource by name — the generic reader covering the long tail (taxes, credit notes, invoice profiles, tasks, staff, gateways, bills, bill vendors, bill payments, other income, expense categories) alongside the ones with dedicated tools. Returns items plus page/pages/total. Some resources are gated by plan or account role and will report that rather than returning rows.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
searchNoRaw FreshBooks filter params passed through verbatim.
per_pageNo
resourceYesAccounting resource to read. All use the alphanumeric accountId.

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.3/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=true; the description adds real value by stating the return shape ('items plus page/pages/total') and the plan/account-role gating behavior that can suppress rows. This goes beyond the structured annotation and gives an agent useful expectations about what a successful or constrained response looks like.

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 dense, information-carrying sentences with no filler. The first establishes scope and positioning against siblings; the second covers output shape and access gating. Every clause earns its place.

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

Completeness5/5

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

For a generic read tool with no output schema, this description covers the resource scope, return fields, pagination presence, and plan/role limitations. The enum and sibling names fill in the remaining context, so an agent has enough to select and invoke the tool correctly.

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?

The resource parameter is already well covered by the enum and schema description, and the search parameter is described in the schema. The description adds little for page and per_page, though the return-note about page/pages/total hints at pagination semantics. With 50% schema coverage, the description is adequate but does not substantially compensate for the undocumented pagination parameters.

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 first sentence states a specific verb ('List'), a clear resource domain ('FreshBooks accounting resource by name'), and positions the tool as the generic reader for the long tail. It also names concrete resources and explicitly contrasts itself with dedicated sibling tools, so an agent can distinguish it without opening the 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?

The description clarifies that this is the generic reader covering long-tail resources while dedicated tools also exist, which strongly implies when to reach for it. It stops short of explicitly saying 'use the dedicated list tool for invoices/clients/etc.' or naming freshbooks_get_record as the singular alternative, so it gives clear context but not a full when/when-not rule.

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