Skip to main content
Glama
mh-zeynal

gapify-mcp-server

by mh-zeynal

Account AgentBots: Get an agent bot details

gapify_get_agent_bot
Read-onlyIdempotent

Retrieve an agent bot's details by ID from a specific Gapify account to inspect its configuration and metadata.

Instructions

Get the details of an agent bot in the account [Account AgentBots] GET /api/v1/accounts/{account_id}/agent_bots/{id} Auth: User 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
account_idYesThe numeric ID of the account

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, openWorld and non-destructive, so the safety profile is covered. The description adds genuinely useful context beyond them: the required auth scheme (User API key in an `api-access-token` header) and the fact that text values are sent unchanged and may contain Persian/Arabic-Indic digits or non-Latin characters.

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 purpose and endpoint are front-loaded in the first line, followed by compact auth and encoding notes. Every element is short and relevant, with no 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 two-parameter read-only fetch with full schema coverage and rich annotations, the description covers purpose, endpoint, auth and data-encoding caveats. With no output schema present it could say a little more about the returned object, but nothing essential to correct invocation is missing.

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 both parameters are already documented and a baseline of 3 applies. The description adds no further meaning about `id` or `account_id`, and notably does not correct the schema's misleading `id` description (it says 'agentbot to be updated' for what is a read-only fetch).

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 in the account') and pins it to the exact REST endpoint, so the agent knows precisely what it retrieves. It does not, however, distinguish itself from the near-identical sibling gapify_platform_get_agent_bot, leaving the agent to guess which variant applies in the account-scoped context.

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 explicit when-to-use or when-not-to-use guidance, and no alternative is named despite multiple overlapping agent-bot getters in the sibling list. Usage is only implied by the endpoint path's account scope.

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