Skip to main content
Glama

insightly

List or search records

insightly_list_records
Read-only

List records of one type — Contacts, Organisations, Leads, Opportunities, Projects, Tasks, Events or Notes — optionally filtered by one field value and/or last-updated time. With field_name + field_value (both required together) or updated_after_utc this uses GET //Search; otherwise GET /. Field names are Insightly's UPPER_SNAKE names, e.g. EMAIL_ADDRESS, LAST_NAME, ORGANISATION_NAME, OPPORTUNITY_STATE, LEAD_RATING, or a custom field such as Industry__c.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topNoMax records to return, 1-500 (API default 100).
skipNoRecords to skip, for paging.
briefNotrue = only top-level fields (no CUSTOMFIELDS, TAGS, LINKS, ...). Smaller and faster.
objectYesRecord type.
field_nameNoField to filter on, e.g. EMAIL_ADDRESS.
count_totalNotrue = also return the total number of matching records (response becomes {total_count, items}).
field_valueNoValue the field must equal.
updated_after_utcNoOnly records updated after this time, yyyy-mm-ddThh:mm:ssZ (e.g. 2026-04-09T16:58:14Z).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, but the description adds real behavioral context beyond annotations: which endpoint is invoked under which parameter combination, and the pairing constraint on field_name/field_value. It omits pagination/return-shape behavior, keeping it short of a 5.

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

Conciseness4/5

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

Three dense sentences, front-loaded with the resource and record types before the filtering mechanics. Every clause carries information, though the examples list is slightly long.

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 an 8-parameter read tool with no output schema, the description covers purpose, both query modes, and field-name syntax adequately. Return-shape details (e.g. what count_total produces) are delegated to the schema, which is acceptable here.

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%, so baseline is 3, but the description adds value the schema lacks: the UPPER_SNAKE field-name convention with concrete examples (EMAIL_ADDRESS, LAST_NAME) and custom-field syntax (Industry__c), plus the both-or-neither rule for field_name/field_value.

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?

States a specific verb and resource and enumerates exactly which record types are supported (Contacts, Organisations, Leads, etc.). It also distinguishes the two operational modes — filtered search vs plain list — which no sibling does.

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?

Clearly explains the condition that selects each mode: field_name+field_value (required together) or updated_after_utc triggers /Search, otherwise plain GET. It does not, however, name alternatives such as insightly_search_by_tag or insightly_get_record for single-record lookups, so the when-not guidance is incomplete.

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.