Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall

freshbooks_get_client

Read-only

Retrieve a client's details from FreshBooks by providing its numeric ID. Use this tool to look up specific client information for accounting workflows.

Instructions

Get a single client by its numeric FreshBooks id.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe client 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 communicates that this is a read-only operation. The description adds only that the id is numeric and the fetch is for a single client, but does not disclose behavior around missing clients, authentication, or return shape. Given the annotation covers the main safety trait, this is acceptable but not rich.

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, direct sentence with no filler. It front-loads the operation, resource, and key identifying detail, making it easy for an agent to parse quickly.

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 simple one-parameter, read-only get-by-id tool, the description plus the input schema and readOnlyHint are largely sufficient. It lacks explicit notes about not-found behavior or response format, but the operation is conventional and simple enough that this is 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%, and the schema already documents the 'id' parameter with type, bounds, and description. The tool description only repeats that the id is numeric, adding little beyond what the structured schema already provides.

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 ('Get'), a specific resource ('a single client'), and the exact identifier ('numeric FreshBooks id'). This clearly distinguishes it from list_clients (bulk retrieval) and create_client (mutation), so the agent can tell it apart from siblings.

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 description implies when to use the tool: when you need one client by its known id rather than listing or searching clients. However, it does not explicitly name alternatives or state when not to use it, 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.