Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall

freshbooks_get_client

Read-only

Retrieve a FreshBooks client by numeric ID to access its details. Use this for viewing or managing client information.

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

B3.1/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds nothing further: no auth requirements, no error behavior for an unknown or unauthorized id, and no return-format context. 'Numeric' mildly clarifies the id, but that is already in the schema.

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 that states verb, resource, lookup key, and id type with zero filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a trivial single-parameter getter this is minimally viable, but there is no output schema, so the description could have said what a successful lookup returns or how a missing/unauthorized id is handled. Those gaps leave an agent to discover the response shape at call time.

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 single 'id' parameter is documented as 'The client id' with type and exclusivity constraints. The description only echoes that it is a numeric FreshBooks id, so baseline 3 is appropriate.

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?

The description states a specific verb and resource ('Get a single client') and constrains the identifier ('by its numeric FreshBooks id'). It implicitly separates itself from freshbooks_list_clients by saying 'a single client', but never names or contrasts with that sibling explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no prerequisites, and no mention of freshbooks_list_clients as the alternative for browsing clients. The usage is only inferable from the verb 'Get' plus the required id, which is minimal.

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