Skip to main content
Glama
mh-zeynal

gapify-mcp-server

by mh-zeynal

AgentBots: Get an agent bot details

gapify_platform_get_agent_bot
Read-onlyIdempotent

Fetch details for a specific agent bot by ID, including configuration and metadata, to inspect or manage support automation.

Instructions

Get the details of an agent bot [AgentBots] GET /platform/api/v1/agent_bots/{id} Auth: Platform app API key (header api-access-token). 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

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds real value beyond them: the required auth scheme and header name ('api-access-token'), plus a locale caveat about Persian/Arabic-Indic digits being passed unchanged. It still does not describe what the response contains.

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 compact and front-loads the purpose before the endpoint, auth and encoding notes. The endpoint and auth lines are boilerplate but plausibly useful; nothing is redundant or padded.

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 single-parameter read with full schema coverage and complete annotations, the description supplies purpose, endpoint, auth and encoding caveats. The one gap is that no output schema exists and the description does not hint at what fields are returned, but the remaining essentials are present.

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% for the single 'id' parameter, which sets a baseline of 3. The description goes slightly further by noting that IDs may be written with Persian or Arabic-Indic digits, which is directly relevant to how the id value is supplied.

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 ('Get the details of an agent bot') and pins the exact endpoint (GET /platform/api/v1/agent_bots/{id}), which implicitly distinguishes it from the sibling gapify_get_agent_bot in a different API surface. However, it never explicitly differentiates itself from the near-identical sibling, leaving the agent to infer the distinction from the 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 guidance on when to use this tool versus alternatives such as gapify_get_agent_bot or gapify_platform_list_agent_bots. The auth note ('Platform app API key') implies a context but does not state the selection condition, so the agent gets no explicit routing help.

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