Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

freshbooks_list_items

Read-only

Retrieve items from a FreshBooks account with pagination and raw filter parameters. Returns matching items plus page, pages, and total counts.

Instructions

List items 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

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, and the description usefully adds that pagination is supported, that raw FreshBooks filter params are passed through verbatim, and that the response carries items plus page/pages/total. It stops short of disclosing rate limits, auth prerequisites, or error behavior, but it clears the (lower) bar set by the annotations.

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?

Three short sentences, front-loaded with the primary action, then pagination/filtering, then return shape. No filler and nothing buried.

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 helpfully states the return envelope (items plus page/pages/total) and the nested search object's pass-through nature is covered by the schema. What is missing is any indication of what 'items' contain or failure modes, but for a simple read/list tool this is close to sufficient.

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%, so page, per_page, and search are already fully documented, including the unvalidated filter-key pass-through. The description only restates that pagination and raw filters exist, adding no format or semantics beyond the schema — the baseline 3 for a fully covered schema.

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

Purpose4/5

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

States a specific verb and resource ('List items') scoped to the authenticated FreshBooks account, and notes pagination plus raw filter pass-through. It is clear what the tool does, though it never explicitly differentiates 'items' from lookalike siblings such as freshbooks_list_services or freshbooks_list_records.

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?

Usage is implied by the resource and the mention of pagination/filter params, but there is no explicit when-to-use, when-not-to-use, or routing to an alternative (e.g. freshbooks_get_item for a single item, or freshbooks_list_services). An agent can infer intent but gets no guidance on selection.

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