Skip to main content
Glama
mh-zeynal

gapify-mcp-server

by mh-zeynal

Accounts: Get an account details

gapify_platform_get_account
Read-onlyIdempotent

Retrieve details for a specific Gapify account by its account ID to view account information through the platform API.

Instructions

Get the details of an account [Accounts] GET /platform/api/v1/accounts/{account_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
account_idYesThe numeric ID of the account

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 declare readOnly, idempotent, non-destructive and open-world behavior, so the safety profile is covered. The description adds genuinely useful context beyond them: the required auth header (`api-access-token`) and the note that text/ID values may arrive in Persian or Arabic-Indic digits.

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 purpose is front-loaded in the first clause, followed by endpoint, auth, and encoding notes. Content is dense but each line carries operational value; the bracketed '[Accounts]' tag is minor noise.

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?

For a single-parameter read tool with no output schema, the description covers invocation (path, auth, encoding) but says nothing about what the returned account details contain, leaving a gap that the absent output schema would otherwise require the description to fill.

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% with a single required account_id, so the baseline is 3. The description contributes extra semantic value by flagging that IDs and numbers may be encoded in Persian or Arabic-Indic digits, which matters for how the agent supplies account_id.

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 ('Get the details of an account') and includes the concrete HTTP endpoint, so the agent knows exactly what it retrieves. It is distinguishable from the create/update/delete account siblings by the read verb, though it does not name them 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 implied by the read-only 'get details' framing and the sibling set, but there is no statement of when to call this versus update_account or list_account_users, and no prerequisites or exclusions are given.

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