Skip to main content
Glama

Get Currencies

whmcs_get_currencies

Retrieve all currencies configured in your WHMCS system. Provides a list of active currencies for management or display.

Instructions

Get configured currencies

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/index.ts:1047-1060 (registration)
    Registration of the 'whmcs_get_currencies' tool via server.registerTool(). It takes no input parameters and calls whmcsClient.getCurrencies().
    server.registerTool(
        'whmcs_get_currencies',
        {
            title: 'Get Currencies',
            description: 'Get configured currencies',
            inputSchema: {},
        },
        async () => {
            const result = await whmcsClient.getCurrencies();
            return {
                content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
            };
        }
    );
  • Handler function getCurrencies() in WhmcsApiClient class. Calls the WHMCS API 'GetCurrencies' action and returns the typed response with currency data (id, code, prefix, suffix, format, rate, default).
    async getCurrencies() {
        return this.call<WhmcsApiResponse & {
            totalresults: number;
            currencies: { currency: Array<{
                id: number;
                code: string;
                prefix: string;
                suffix: string;
                format: number;
                rate: string;
                default: number;
            }> };
        }>('GetCurrencies');
    }
Behavior2/5

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

With no annotations, the description carries the full burden. It does not disclose any behavioral traits such as data limits, error responses, or side effects. Only states the purpose.

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?

The description is a single concise phrase with no unnecessary words. It is front-loaded and efficient.

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 simple parameterless getter, the description is adequate but could be enhanced by noting the return format (e.g., list of currencies) or usage context. With no output schema, more detail would be beneficial.

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 input schema has no parameters, so the description does not need to explain any. Baseline for zero parameters is 4, and the description adds no confusion.

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 'Get configured currencies' clearly states the action (GET) and the resource (currencies). There is no other sibling tool for currencies, so it is distinct.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies this tool is for retrieving all configured currencies. Since no sibling tool targets currencies, it is clear when to use it, though no explicit when-not or alternatives are provided.

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/scarecr0w12/whmcs-mcp-tool'

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