Skip to main content
Glama

List leads

crm_list_leads
Read-onlyIdempotent

Leads in this workspace, newest activity first. Phone and email are MASKED here — use crm_get_lead for one record when the full contact is genuinely needed. total is the count before paging, so it answers 'how many leads exist'. [scope: crm:read]

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum number of rows to return.
sinceNotoday | yesterday | week | month | 7d | 30d | ISO timestamp. Days are Asia/Dubai.
stageNoStage name, exact (case-insensitive). Omit for all stages.
offsetNoRows to skip before the first returned row (for paging).
pipeline_idNoUUID of one pipeline. Omit for all.

Output Schema

NameRequiredDescriptionDefault
okNoFalse when the call was refused or failed; see error.
errorNoMachine-readable refusal code (a string), present only when ok is false.
messageNoHuman-readable explanation of a refusal (a string).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / offset / maximum
      Added value: +5000
    • addedInput schema / properties / pipeline_id / format
      Added value: +"uuid"
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "error": {
      +      "description": "Machine-readable refusal code (a string), present only when ok is false."
      +    },
      +    "message": {
      +      "description": "Human-readable explanation of a refusal (a string)."
      +    },
      +    "ok": {
      +      "description": "False when the call was refused or failed; see error.",
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Changed2 schema fields changed
    • addedInput schema / properties / limit / description
      Added value: +"Maximum number of rows to return."
    • addedInput schema / properties / offset / description
      Added value: +"Rows to skip before the first returned row (for paging)."
  4. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Beyond the readOnly/idempotent/non-destructive annotations, it discloses three things an agent can't get from structured fields: phone and email are MASKED, results are ordered by newest activity, and `total` is the pre-pagination count. It also states the required auth scope (crm:read). That is material behavioral context layered on top of 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.

Conciseness5/5

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

Three short sentences, each earning its place: scope+ordering, the masking caveat with the sibling route, and the `total` paging semantics. The critical constraint (masking) is front-loaded rather than buried.

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 annotations covering the safety profile and an output schema existing, the remaining gaps an agent would face are masking, ordering, paging semantics and permissions — and the description covers all four. Nothing needed to call it correctly is missing.

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%, so limit, since, stage, pipeline_id and offset are already fully documented with formats, defaults and bounds. The description adds no input-parameter guidance (its only data-semantics note, about `total`, concerns the response), which is exactly the baseline-3 case.

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 establishes the resource and scope ('Leads in this workspace') plus ordering ('newest activity first'), which is enough to distinguish it from crm_get_lead, which it names directly. It does not carry an explicit verb of its own (the 'list' verb lives only in the name/title), so it falls just short of a full 5.

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?

It gives an explicit alternative and the condition for choosing it: 'use crm_get_lead for one record when the full contact is genuinely needed.' It also clarifies what question this tool answers via `total`. It does not address the other list-shaped sibling (crm_leads_without_task) or state when not to page here, so guidance is clear but not exhaustive.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.