Skip to main content
Glama
mh-zeynal

gapify-mcp-server

by mh-zeynal

Conversations: Conversations Filter

gapify_filter_conversations

Filter and paginate customer-support conversations using custom conditions to locate specific tickets by status, language, or other attributes.

Instructions

Filter conversations with custom filter options and pagination [Conversations] POST /api/v1/accounts/{account_id}/conversations/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":"browser_language","filter_operator":"not_eq","values":["en"],"query_operator":"AND"},{"attribute_key":"status","filter_operator":"eq","values":["pending"],"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.8/5.0
Behavior4/5

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

Annotations only cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false, openWorldHint=true). The description adds genuinely useful non-schema behavior: dual auth paths (User API key or Agent bot key via api-access-token header), the concrete endpoint, extra_body merge semantics, and that Persian/Arabic-Indic digits are forwarded unchanged. It does not explain pagination limits or result shape.

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?

Purpose is front-loaded in the first clause, with auth and body notes following in a compact block. Mild redundancy in 'Body fields: payload' since payload is fully specified in the schema, but no genuinely wasted sentences.

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?

No output schema exists, but the description covers the operation, auth, endpoint and body-extension mechanism, which is most of what an agent needs. Gaps are minor: no note on pagination behavior/limits and no mention of the non-read-only annotation despite the filter semantics, though the schema example adequately carries the filter DSL.

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 the baseline is 3 and the schema already documents payload, page, account_id and extra_body with an example. The description goes slightly beyond the schema by flagging that text values pass through unchanged and that IDs/numbers may arrive in Persian or Arabic-Indic digits — a real encoding caveat not captured elsewhere.

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 specific verb+resource ('Filter conversations') plus scoping qualifiers (custom filter options, pagination). It implicitly distinguishes itself from gapify_list_conversations by emphasizing custom filters, but never names the sibling or states the difference explicitly.

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: an agent can infer this is the tool for filtered/advanced conversation queries versus a plain list. There is no explicit when-to-use, when-not-to-use, or alternative routing among the several nearby conversation siblings (list_conversations, get_conversation_counts).

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