Skip to main content
Glama

IDX Broker MCP by usefulapi

List leads

idx_list_leads
Read-only

List the account's leads (website registrants) with contact details, status, agent owner, and last viewed listings and searches. A reply holds up to 500 leads; pass offset to page on and look for pagination information in the reply. Filter by a time window on signup, edit, login or activity date. Uses one of the key's hourly API accesses. GET /leads/lead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsNoOnly return these fields (IDX `rf`); ["*"] returns every available field. Narrow it to save API size.
offsetNoItems to skip from the beginning (default 0).
sort_byNoSort by creation order, asc or desc.
intervalNoHours of data to return, counted back from start_datetime (default: now). 0.0166 (one minute) to 168; decimals allowed. IDX default when omitted: 1 hour; pass up to 168 for one week.
date_typeNoWhich date the time window applies to (default subscribeDate).
start_datetimeNoWhere the interval starts counting back (the newest moment wanted). Default: now. ISO 8601 with a timezone.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already mark this read-only and non-destructive, and the description still adds real behavioral facts: a 500-lead per-reply cap, offset-based paging with pagination info in the reply, and that each call draws on the key's hourly API quota. It also discloses the underlying GET /leads/lead endpoint, which matters for open-world rate-limited APIs.

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?

Four sentences, each carrying distinct load: payload contents, page-size limit and paging, filtering options, and cost. The most decision-relevant facts (what you get, how big, what it costs) come first with 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 carries the return-value burden and does so by enumerating the returned field groups and the 500-item page size with paging pointer. Safety is covered by annotations, cost by the quota note, and filtering by the date-window sentence, leaving nothing essential for a correct call unstated.

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 all six parameters including the date_type enum and interval bounds are already documented, making 3 the baseline. The description only loosely reinforces that a time window applies to signup, edit, login, or activity dates and that offset pages; it adds no format or interaction detail beyond the schema.

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 names a specific verb and resource ('List the account's leads') and defines the resource precisely as website registrants, plus the fields returned. That scope is enough to separate it from idx_get_lead (single record) and from the per-lead listers such as idx_list_lead_searches without opening a schema.

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 concrete usage context: filter with a time window on one of four date bases, page with offset when a reply exceeds 500 leads, and expect it to consume an hourly API access. It does not explicitly say when to prefer this over idx_get_lead or idx_list_lead_searches, so no exclusions or alternatives are stated.

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.