Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

freshbooks_list_records

Read-only

List FreshBooks accounting resources such as taxes, credit notes, tasks, staff, bills, and vendors, with page and per-page controls. Pass raw filters to reach the long tail of records.

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/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 safety is covered. The description adds genuinely non-obvious behavior: the return shape ('items plus page/pages/total') and the fact that plan- or role-gated resources report an error rather than returning rows. It does not mention rate limits or how the gating error surfaces, so it is not exhaustive.

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

Conciseness4/5

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

Front-loaded with the core purpose, then two short supporting sentences on return shape and gating. The long parenthetical resource list is dense but justified since it enumerates the tool's actual scope, though it partly repeats the enum.

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 usefully describes the return envelope (items plus page/pages/total) and warns about plan/role gating. The main remaining gap is pagination/filter parameter behavior, which neither the schema nor the description covers.

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

Parameters2/5

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

Schema coverage is only 50% — 'page' and 'per_page' carry no schema descriptions, and the description says nothing about pagination or the pass-through 'search' object. The resource list in the description duplicates the enum already present in the schema, adding no new semantic value. With half the parameters undocumented in both places, the description fails to compensate.

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 states a specific verb+resource ('List any FreshBooks accounting resource by name') and explicitly positions itself as 'the generic reader covering the long tail', naming concrete examples (taxes, credit notes, invoice profiles, tasks, staff, gateways, bills, etc.). It also distinguishes itself from siblings that have dedicated tools, so an agent can route correctly without opening a 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?

It clearly signals when this tool is the right choice — for the long-tail resources that lack dedicated tools — which is real routing guidance. It stops short of an explicit exclusion ('use freshbooks_list_invoices for invoices'), so an agent must infer that dedicated tools take precedence for the overlapping resources.

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