Skip to main content
Glama

Set Order to Pending

whmcs_pending_order

Set an order's status to pending in WHMCS by providing its order ID.

Instructions

Set an order status to pending

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orderidYesOrder ID

Implementation Reference

  • src/index.ts:869-884 (registration)
    Registration of the 'whmcs_pending_order' tool via server.registerTool() with input schema (orderid) and handler delegating to whmcsClient.pendingOrder()
    server.registerTool(
        'whmcs_pending_order',
        {
            title: 'Set Order to Pending',
            description: 'Set an order status to pending',
            inputSchema: {
                orderid: z.number().describe('Order ID'),
            },
        },
        async (params) => {
            const result = await whmcsClient.pendingOrder(params);
            return {
                content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
            };
        }
    );
  • Handler function for whmcs_pending_order that calls whmcsClient.pendingOrder(params) and returns the result as JSON text content
    async (params) => {
        const result = await whmcsClient.pendingOrder(params);
        return {
            content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
        };
    }
  • Input schema for whmcs_pending_order: requires orderid as a number
        inputSchema: {
            orderid: z.number().describe('Order ID'),
        },
    },
  • PendingOrder API client method in WhmcsApiClient class. Calls WHMCS API action 'PendingOrder' with the orderid parameter via the generic this.call() method
    /**
     * Set order to pending
     */
    async pendingOrder(params: { orderid: number }) {
        return this.call<WhmcsApiResponse>('PendingOrder', params);
    }
Behavior2/5

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

No annotations are present, and the description does not disclose any behavioral details beyond the basic action. Missing information includes whether the operation is reversible, triggers workflows, requires specific permissions, or has any side effects.

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 description is a single, clear sentence with no unnecessary words. It is appropriately concise for a simple tool.

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

Completeness2/5

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

Given the context of many sibling status-related tools, the description is too minimal. It does not explain what 'pending' means, how it differs from other statuses, or what the outcome is. For a single-parameter tool, more context would be helpful for correct tool selection.

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?

The input schema has 100% coverage, with the parameter 'orderid' having a description of 'Order ID'. The description adds no additional meaning beyond what the schema provides, so a baseline score of 3 is appropriate.

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 states the action ('Set an order status to pending') with a specific verb and resource (order status). It distinguishes itself from sibling tools like whmcs_accept_order, whmcs_cancel_order, and whmcs_fraud_order, which set different statuses.

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?

No guidance is provided on when to use this tool versus alternatives (e.g., accept_order, cancel_order). There is no mention of prerequisites, order states, or when setting to pending is appropriate.

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