Skip to main content
Glama
mh-zeynal

gapify-mcp-server

by mh-zeynal

Account AgentBots: Update an agent bot

gapify_update_agent_bot

Update an agent bot's name, description, or outgoing webhook URL through the Gapify API to keep customer-support bot settings current.

Instructions

Update an agent bot's attributes [Account AgentBots] PATCH /api/v1/accounts/{account_id}/agent_bots/{id} Auth: User API key (header api-access-token). Body fields: name, description, outgoing_url. 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
idYesThe ID of the agentbot to be updated
nameNoThe name of the agent bot
account_idYesThe numeric ID of the account
extra_bodyNoAdditional JSON body fields to merge into the request (for keys not listed above).
descriptionNoThe description about the agent bot
outgoing_urlNoThe webhook URL for the bot Example: "https://example.com"

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 already cover the safety profile (readOnly=false, destructive=false, openWorld=true), so the bar is lower. The description adds real context beyond them: the exact auth header (`api-access-token`), the extra_body merge mechanism, and the i18n handling of Persian text and Arabic-Indic digits. It still omits whether unmentioned fields are preserved or cleared during the update.

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?

Front-loads the purpose and endpoint in the first two lines, then groups auth, body fields, and the i18n caveat compactly. Slightly more text than strictly needed, but no sentence is pure filler.

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 a six-parameter mutation tool with no output schema but full schema coverage and annotations, the description supplies the pieces an agent needs: endpoint, auth, writable fields, and the extra_body escape hatch. Missing only partial-update semantics and error behavior, which is a minor gap.

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 documents every parameter; the baseline is 3. The description reinforces the three writable body fields and explains how extra_body carries unlisted keys, but adds little syntax or format detail the schema lacks.

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 and resource ("Update an agent bot's attributes") and pins it with the exact PATCH endpoint and the [Account AgentBots] scope. It does not, however, differentiate this tool from the near-identical siblings gapify_platform_update_agent_bot and gapify_update_agent, so an agent could still confuse them.

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 update semantics and the account-scoped endpoint, but there is no explicit when-to-use statement, no mention of the create/delete siblings, and no note on when the platform-level variant should be preferred instead.

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