Skip to main content
Glama
mh-zeynal

gapify-mcp-server

by mh-zeynal

Contacts: Contact Filter

gapify_filter_contacts

Filter contacts by custom attribute conditions and operators with pagination to find matching records. Supports Persian values and multi-condition AND/OR queries.

Instructions

Filter contacts with custom filter options and pagination [Contacts] POST /api/v1/accounts/{account_id}/contacts/filter Auth: User API key or Agent bot API key (header api-access-token). Body fields: payload. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoQuery param. Page number, starting at 1.
payloadNoArray of filter conditions. Each item: {attribute_key, filter_operator (e.g. equal_to, not_equal_to, contains, does_not_contain), values: [...], query_operator: "AND" | "OR", null on the last item}. Values may be Persian text. Example: [{"attribute_key":"name","filter_operator":"equal_to","values":["en"],"query_operator":"AND"},{"attribute_key":"country_code","filter_operator":"equal_to","values":["us"],"query_operator":null}]
account_idYesThe numeric ID of the account
extra_bodyNoAdditional JSON body fields to merge into the request (for keys not listed above).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A3.7/5.0
Behavior4/5

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

Annotations declare a non-read-only, open-world, non-idempotent profile, and the description corroborates this by disclosing the raw HTTP surface (POST endpoint) and the auth requirement (User API key or Agent bot API key via `api-access-token` header). The Persian/Farsi and Arabic-Indic digit passthrough note is genuinely useful behavioral context not derivable from annotations or schema.

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?

The definition is front-loaded with the purpose, then method, auth, and body fields in compact fashion. The closing digit-encoding sentence is somewhat tangential but short and adds distinct value; overall little waste.

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?

With no output schema, the description supplies the endpoint, HTTP method, auth scheme, body-field pointer, and the extra_body escape hatch, which is adequate context for calling this nested-payload filter. Sibling differentiation is the main gap, but the mechanics of invocation are well covered.

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 fully documents page, payload, account_id, and extra_body. The description only restates that 'payload' is the body field and that extra_body carries unlisted keys, adding no syntax or format detail beyond the schema. Baseline 3 applies.

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?

States a clear verb+resource: 'Filter contacts with custom filter options and pagination.' This distinguishes it from plain listing, and the 'custom filter options' phrasing signals the structured payload approach. However it never names the alternatives (gapify_list_contacts, gapify_search_contacts), so the agent must infer the boundary itself.

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 only implied. The description mentions custom filter options and pagination but gives no explicit when-to-use or when-not-to-use versus siblings like search_contacts or list_contacts. Auth prerequisites and body-field naming are present, but routing guidance to alternatives is absent.

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