Skip to main content
Glama
virtualsms-io

VirtualSMS MCP Server

Get Account Profile

virtualsms_get_profile
Read-onlyIdempotent

Retrieve your full VirtualSMS account profile: email, balance, lifetime spend, total orders, active API keys, Telegram link status, and creation date.

Instructions

Full account profile: email, Telegram link status, current balance, lifetime spend, total orders, active API keys, and account creation date.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler function that executes the virtualsms_get_profile tool logic. Calls client.getProfile() and returns the profile as JSON.
    export async function handleGetProfile(client: VirtualSMSClient) {
      const profile = await client.getProfile();
      return {
        content: [
          {
            type: 'text' as const,
            text: JSON.stringify(profile, null, 2),
          },
        ],
      };
    }
  • Input schema (Zod) for get profile - empty object, no parameters required.
    export const GetProfileInput = z.object({});
  • src/tools.ts:512-530 (registration)
    Tool definition registration in TOOL_DEFINITIONS array - name, title, description, inputSchema, and annotations.
    {
      name: 'virtualsms_get_profile',
      title: 'Get Account Profile',
      description:
        'Full account profile: email, Telegram link status, current balance, lifetime spend, total orders, ' +
        'active API keys, and account creation date.',
      inputSchema: {
        type: 'object' as const,
        properties: {},
        required: [],
      },
      annotations: {
        title: 'Get Account Profile',
        readOnlyHint: true,
        destructiveHint: false,
        idempotentHint: true,
        openWorldHint: true,
      },
    },
  • Client-side HTTP method getProfile() that calls /api/v1/customer/profile and maps the raw API response to the Profile interface.
    async getProfile(): Promise<Profile> {
      this.requireApiKey();
      const res = await this.http.get('/api/v1/customer/profile');
      const raw = res.data as Record<string, unknown>;
      return {
        id: String(raw.id ?? ''),
        email: String(raw.email ?? ''),
        telegram_linked: Boolean(raw.telegram_linked),
        telegram_username: raw.telegram_username ? String(raw.telegram_username) : undefined,
        balance_usd: Number(raw.balance_usd ?? 0),
        total_spent_usd: Number(raw.total_spent_usd ?? 0),
        total_credits_usd: Number(raw.total_credits_usd ?? 0),
        total_orders: Number(raw.total_orders ?? 0),
        active_api_keys: Number(raw.active_api_keys ?? 0),
        created_at: String(raw.created_at ?? ''),
      };
    }
  • Profile interface definition with fields: id, email, telegram_linked, telegram_username, balance_usd, total_spent_usd, total_credits_usd, total_orders, active_api_keys, created_at.
    export interface Profile {
      id: string;
      email: string;
      telegram_linked: boolean;
      telegram_username?: string;
      balance_usd: number;
      total_spent_usd: number;
      total_credits_usd: number;
      total_orders: number;
      active_api_keys: number;
      created_at: string;
    }
Behavior3/5

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

Annotations already provide readOnlyHint, destructiveHint=false, idempotentHint. Description adds no behavioral context beyond field listing, such as side effects or response handling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single sentence efficiently lists all returned fields with no redundancy. Front-loaded with 'Full account profile'.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given zero parameters, no output schema, and rich annotations, the description sufficiently explains what the tool returns. It covers all relevant aspects for using the tool.

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?

No parameters exist, so description does not need to add meaning. Baseline of 4 applies as there is no param info to supplement.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly specifies that the tool retrieves the full account profile, listing specific fields like email, balance, orders, etc. It distinguishes itself from siblings that handle orders, balance, or SMS operations.

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?

No explicit guidance on when to use this tool versus alternatives. The description implies it is for viewing account profile, but does not state exclusions or mention sibling tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/virtualsms-io/mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server