Skip to main content
Glama
mh-zeynal

gapify-mcp-server

by mh-zeynal

Profile: Fetch user profile

gapify_get_profile
Read-onlyIdempotent

Retrieve the profile of the user who owns the API access token to identify the account owner and personalize support interactions.

Instructions

Get the profile of the user who owns the API access token [Profile] GET /api/v1/profile 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

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A3.8/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 real context beyond that: the required auth scheme (User API key in the api-access-token header) and the encoding caveat about Persian/Arabic-Indic digits, which an agent handling responses would otherwise miss.

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-loaded with the purpose in one sentence, followed by compact auth and encoding notes. The '[Profile] GET /api/v1/profile' line is mildly redundant REST metadata but costs almost nothing.

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 zero-parameter read tool with no output schema, the description covers purpose, target resolution, auth requirement and encoding caveats. The only gap is that it never hints at what fields the profile object contains, which an agent might want before relying on the result.

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?

The tool takes zero parameters, so the baseline is 4. The description correctly conveys that no identifiers are accepted – the token itself determines the target – and adds the auth and numeral-encoding context relevant to using the response.

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: fetch the profile of the user who owns the API access token. The 'token owner' qualifier usefully distinguishes it from the many sibling get_user / get_contact / get_account tools, though no sibling is named 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 user who owns the API access token' – this is the self-profile endpoint, not an arbitrary-user lookup – but there is no explicit when-to-use statement or pointer to gapify_platform_get_user as the alternative for fetching another user.

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