Skip to main content
Glama
RPasquale

lightbulb-mcp

by RPasquale
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

freshbooks_list_clients

Read-onlyIdempotent

Lists clients from a FreshBooks account using the configured connector.

Instructions

Freshbooks connector operation list_clients (platform tool freshbooks.list_clients).

Routes only through the exact project/account governed connector authority.

Args: arguments: JSON string of arguments for the connector operation. project_id: Authenticated Project UUID. project_ref: Exact project correlation reference. connector_account_ref: Project-bound connector account alias. idempotency_key: Stable business-action identity. effect: Required and must be read; Spring verifies it. approval_ref: Approved platform task UUID when resuming a write.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
effectYes
argumentsNo{}
project_idNo
project_refNo
approval_refNo
idempotency_keyNo
connector_account_refNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv0.1.1
    • addedInput schema / properties / approval_ref
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "title": "Approval Ref"
+}
    • addedInput schema / properties / connector_account_ref
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "title": "Connector Account Ref"
+}
    • addedInput schema / properties / effect
      Added value: +{
+  "const": "read",
+  "title": "Effect",
+  "type": "string"
+}
    • addedInput schema / properties / idempotency_key
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "title": "Idempotency Key"
+}
    • addedInput schema / properties / project_id
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "title": "Project Id"
+}
    • addedInput schema / properties / project_ref
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "title": "Project Ref"
+}
    • addedInput schema / required
      Added value: +[
+  "effect"
+]
  2. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already provide readOnly/openWorld/idempotent/non-destructive hints. The description adds the operational fact that calls must route through the exact governed project/account connector authority and that Spring verifies the effect parameter, which is useful context. The approval_ref mention of resuming a write is odd for a read-only tool but does not contradict the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The Args list is compact and scannable, and each line is short. The opening sentence duplicates the tool name/platform identifier and the approval_ref write note is not relevant to this read operation, so a little space is wasted. Overall size is appropriate.

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?

Even with a rich output schema and annotations, the description is only minimally sufficient: it never explains what clients means in this Freshbooks context, how to populate the arguments JSON, or which of project_id/project_ref/connector_account_ref are required to satisfy the governed routing. An agent could probably call it correctly by setting effect='read', but selection confidence and payload construction remain underspecified.

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?

With 0% schema description coverage, the description carries the full burden and gives every parameter a semantic gloss (e.g., arguments is a JSON string, project_id is an authenticated project UUID, connector_account_ref is a project-bound account alias). That is more than the schema's bare titles provide. However, the critical arguments parameter has no documented allowed keys or example, and some definitions are still jargon, so it stops short of being fully actionable.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence identifies the operation as 'Freshbooks connector operation list_clients' but does not state in plain terms that the tool retrieves Freshbooks clients or what the result set includes. It is essentially a restatement of the tool name, with the only additional prose being a routing constraint. This is minimally clear but lacks descriptive substance.

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?

The description never tells an agent when to pick this tool over sibling Freshbooks operations such as freshbooks_list_invoices, freshbooks_list_expenses, or freshbooks_list_payments. 'Routes only through the exact project/account governed connector authority' is a routing/authorization constraint, not a selection criterion. There is no exclusions, prerequisites, or alternative-tool guidance.

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

Deploy Server

Other Tools