Skip to main content
Glama
chrischall

freshbooks-mcp

by chrischall

freshbooks_get_identity

Read-only

Resolve the authenticated FreshBooks user and their accountId, businessId, and businessUuid so you call the right API 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.7/5.0
Behavior5/5

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

Annotations only cover readOnlyHint and openWorldHint; the description adds substantive behavior beyond them: the three identifiers are not interchangeable and the wrong one yields a 404 instead of a useful error, multi-business accounts populate a `businesses` list, and writes are blocked without an explicit business selection. That is real error-mode and side-effect disclosure.

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?

Three sentences, front-loaded with the core action and then packed with the identifier distinctions and the write-refusal caveat. Every clause carries decision-relevant information; there is no filler.

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?

With no output schema, the description must describe what comes back, and it does: the three identifier fields plus the `businesses` list for multi-business accounts. Combined with the 404 and write-refusal warnings, an agent has everything needed to call and use this tool correctly.

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 takes zero parameters, so per the baseline this dimension is at 4. The description adds useful meaning about the identifiers it resolves, though that is return-value information rather than parameter guidance.

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 and resource: 'Resolve the authenticated FreshBooks user and their identifiers', then enumerates exactly what is returned (accountId, businessId, businessUuid). No sibling tool in the list performs identity resolution, so an agent can route here unambiguously.

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?

Gives clear downstream context: accountId is for accounting/payments endpoints and businessId for projects/time tracking, which tells the agent when each value is needed. It also states that writes are refused unless FRESHBOOKS_BUSINESS_ID selects a business. It stops short of an explicit 'call this first / call this before X' instruction, so it is strong context rather than a full when-to-use rule.

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