Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall

freshbooks_get_invoice

Read-only

Retrieve a specific invoice from FreshBooks by its numeric ID to view details or verify billing information.

Instructions

Get a single invoice by its numeric FreshBooks id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe invoice id

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. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes this as a safe read operation, and the description's 'Get' is consistent with that. The description adds no behavioral context beyond the annotation, such as not-found behavior or return shape, but for a simple getter the annotation covers the main safety trait.

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?

One short, front-loaded sentence with no filler. It places the operation first, then the resource and the lookup key, making every word meaningful.

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 one-parameter read-only getter, the description supplies the essential selection and invocation information. It does not explicitly describe the return value or error behavior, but the simplicity of the operation and the readOnlyHint annotation make this a minor gap.

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 the id property described as 'The invoice id', so the baseline applies. The description only adds 'numeric', which duplicates the integer type already present in the schema.

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?

States a specific verb ('Get'), a specific resource ('single invoice'), and the lookup key ('numeric FreshBooks id'). This clearly distinguishes it from siblings like freshbooks_list_invoices and freshbooks_update_invoice.

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 phrase 'a single invoice by its numeric FreshBooks id' implies the intended use case: retrieving one record by ID. However, it does not explicitly say when to prefer list_invoices or mention alternatives/exclusions, leaving some inference to the agent.

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