Skip to main content
Glama

IDX Broker MCP by usefulapi

List lead notes

idx_list_lead_notes
Read-only

Notes on a lead, or one note when note_id is given. GET /leads/note/{leadID}[/{noteID}].

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsNoOnly return these fields (IDX `rf`); ["*"] returns every available field. Narrow it to save API size.
lead_idYesIDX lead id.
note_idNoOne note id; omit for all notes of the lead.
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.
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

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, and destructiveHint=false. The description adds useful context by naming the underlying GET endpoint and the single-note variant, but does not disclose pagination, rate limits, or output shape.

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, front-loaded with the tool's purpose and the key note_id condition. There is no filler, and the endpoint reference adds concrete context without bloat.

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?

Given the annotations, 100% schema coverage, and lack of an output schema, the description provides enough for correct invocation. It could say more about the returned note structure or pagination, but for a read-only notes listing it is largely sufficient.

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 the schema already documents all parameters, including note_id and fields. The description restates the note_id behavior but adds no syntax or semantic detail beyond what the schema provides.

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 clearly identifies the resource (lead notes) and the two modes: all notes for a lead, or one note when note_id is provided. It does not explicitly contrast with siblings like idx_add_lead_note, but the retrieval purpose is unambiguous.

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?

Usage is implied by the note_id conditional, which tells the agent how to switch between listing and fetching a single note. However, it does not state when to use this versus idx_get_lead or idx_add_lead_note, nor does it give exclusions or prerequisites.

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.