Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall

freshbooks_get_identity

Read-only

Resolve authenticated FreshBooks user identifiers (accountId, businessId, businessUuid) to use the correct ID per endpoint and avoid 404 errors.

Instructions

Resolve the authenticated FreshBooks user and their identifiers: accountId (alphanumeric, used by accounting and payments endpoints), businessId (integer, used by projects and time tracking) and businessUuid. The three are not interchangeable — using the wrong one returns a 404 rather than a useful error. When the identity belongs to several businesses, businesses lists them all; unless FRESHBOOKS_BUSINESS_ID picks one, writes are refused.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only provide readOnlyHint=true; the description adds substantial behavioral context beyond that: the specific error behavior (404 on wrong ID), the multi-business listing, and the write-refusal rule. It also clarifies that the tool resolves identity without side effects, consistent with the read-only hint.

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 three sentences, each earning its place. The first sentence states the purpose and lists the identifiers; the second warns about interchangeability and error behavior; the third explains the multi-business scenario and the write-refusal condition. It is front-loaded with the core action and scoped efficiently.

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

Completeness5/5

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

Given no output schema, the description fully explains the return values (accountId, businessId, businessUuid, and businesses list) and their meaning. It also covers edge cases (multiple businesses, write refusal) and error behavior. An agent can call this tool without any further guidance.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, so the schema is trivially 100% covered. The baseline for 0 params is 4, and the description adds value by explaining the semantic meaning of the identifiers returned, even though that is output-oriented rather than parameter-oriented. There is nothing missing regarding parameters.

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 opens with a clear, specific verb+resource: 'Resolve the authenticated FreshBooks user and their identifiers.' It explicitly names the three identifier fields (accountId, businessId, businessUuid) and distinguishes them by their usage. This is distinct from all sibling tools, none of which are identity-resolution tools.

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

Usage Guidelines5/5

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

The description explains when this tool is needed (to obtain the user's identity) and provides critical usage guidance: the identifiers are not interchangeable, and using the wrong one yields a 404. It also warns that writes are refused when the identity belongs to multiple businesses unless FRESHBOOKS_BUSINESS_ID selects one, giving the agent an explicit precondition for subsequent mutations.

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