Skip to main content
Glama
mh-zeynal

gapify-mcp-server

by mh-zeynal

Conversations API: Create a conversation

gapify_client_create_conversation

Create a customer-support conversation in a specific inbox for a contact, adding custom attributes to start or organize support threads.

Instructions

Create a conversation [Conversations API] POST /public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations Body fields: custom_attributes. 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
extra_bodyNoAdditional JSON body fields to merge into the request (for keys not listed above).
inbox_identifierYesThe identifier obtained from API inbox channel
custom_attributesNoCustom attributes of the conversation Example: {}
contact_identifierYesThe source id of contact obtained on contact create

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare the safety profile (readOnlyHint=false, idempotentHint=false, openWorldHint=true, destructiveHint=false), so the description need not restate them. It adds some real context: the endpoint path, the ability to pass extra body fields via extra_body, and the fact that text and digits are forwarded unchanged. It says nothing about auth requirements, duplicate handling, or what a successful creation yields.

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 core action is front-loaded in the first clause, followed by the endpoint and body information in a compact block. The Persian-digit sentence is somewhat tangential but is relevant to how input values are handled, so it earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and a mutation tool, the description should carry more of the behavioral burden. It covers the endpoint, the body shape, and the extra_body escape hatch, but omits error conditions, authentication expectations, and any notion of what the call returns, leaving gaps for a non-idempotent create operation.

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 four parameters, making 3 the baseline. The description's only additive note is that values may be supplied in Persian or Arabic-Indic digits and are sent unchanged, which is a marginal semantic detail rather than a substantive clarification of inbox_identifier or contact_identifier.

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 states a specific verb and resource ('Create a conversation') and even pins the exact REST endpoint, which removes ambiguity about what is being created. However, it never distinguishes this client-scoped variant from the sibling gapify_create_conversation, so an agent must infer the difference from the '[Conversations API]' tag and the inbox/contact path.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no prerequisites, and no mention of the closely related sibling gapify_create_conversation. An agent choosing between the two create-conversation tools gets no routing signal.

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