Skip to main content
Glama

List clients

crunch_list_clients
Read-only

List clients with email, payment terms and billing address, and use their IDs as the customer on invoices. Search and filter results by field or keyword.

Instructions

List the business's clients (the customers you invoice) with email, payment terms and billing address. Use the IDs as the customer on invoices.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "crunch_list_clients"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNoReturn the full objects from the API instead of compact summaries (larger)
limitNoMaximum number of items
fieldsNoKeep only these fields (dot paths, such as supplier.companyName)
searchNoCase-insensitive substring match on any value

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.0

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds the useful detail that results carry email, payment terms and billing address, giving a sense of return contents since no output schema exists, but it says nothing about result volume, pagination, or ordering. Given annotations cover the core traits, this is a modest addition rather than rich behavioral context.

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?

Two short sentences with zero filler: the resource and its payload come first, and the practical downstream use follows. Nothing is repeated from the schema or annotations.

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, optional-parameter list tool with no output schema, the description supplies the resource identity, the returned fields, and the reason the IDs matter. The remaining gap is result-set behavior (pagination, ordering, defaults), which is minor for this complexity.

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?

Schema coverage is 100% and each of the four parameters (raw, limit, fields, search) is documented in the schema itself, so the baseline of 3 applies. The description slightly exceeds it by contrasting compact listings with the schema's 'raw' full-object mode and by indicating what the compact fields contain.

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 ('List the business's clients') and disambiguates the term with a parenthetical ('the customers you invoice'), which separates it from crunch_list_suppliers. It also names the key fields returned. It stops short of explicitly routing the agent away from crunch_get_client or crunch_list_suppliers by name, so it is clear but not fully sibling-differentiated.

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 second sentence gives downstream usage guidance ('Use the IDs as the customer on invoices'), which tells the agent why to call this before creating an invoice. However, there is no guidance on when to use this versus crunch_get_client for a single client or versus the search/fields parameters for narrowing results.

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