Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

freshbooks_list_estimates

Read-only

Retrieve estimates from your FreshBooks account with pagination and filter support. Get item lists, pages, and totals.

Instructions

List estimates 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.2/5.0
Behavior4/5

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

The readOnlyHint annotation already signals a safe read operation, lowering the bar. The description adds valuable behavioral details: it supports pagination and raw filter params, and specifies the return shape (items plus page/pages/total). This goes beyond the annotation and informs the agent of expected output structure and flexibility, though it does not disclose potential rate limits or error conditions.

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?

The description is a single, front-loaded sentence that immediately states the core function. It includes key details (pagination, filters, return format) without any fluff. Every clause contributes value, making it highly efficient for an agent to parse.

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 operation with optional parameters, the description is sufficiently complete. It mentions the return format (items plus page/pages/total), which is essential since there is no output schema. It does not mention authentication, but 'authenticated FreshBooks account' implies that. Minor gaps like pagination defaults or error behavior are not critical for a read-only list tool, so this is a solid 4.

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 the schema already documents all three parameters (page, per_page, search) with their descriptions. The description's mention of 'pagination and raw FreshBooks filter params' slightly reinforces the purpose of the search parameter but does not add significant meaning beyond the schema. With full coverage, the baseline of 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 states a specific verb and resource: 'List estimates for the authenticated FreshBooks account.' It clearly distinguishes from the sibling tool freshbooks_get_estimate (singular) and other list tools like freshbooks_list_invoices. The purpose is unambiguous and directly indicates the operation.

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 gives clear context that this tool lists estimates, implying it should be used when retrieving multiple estimates or with filters. However, it does not explicitly mention when not to use it (e.g., when a single estimate is needed, use get_estimate) or reference any alternatives. It provides clear context but lacks explicit exclusions.

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