Skip to main content
Glama

Add Ticket Note

whmcs_add_ticket_note

Add an internal note to a ticket that only admins can see and does not trigger email notifications.

Instructions

Add an admin-only internal note to a ticket. Notes are not visible to the client and do not trigger email notifications.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ticketidYesTicket ID to add the note to
messageYesThe note content
markdownNoWhether the message contains markdown formatting

Implementation Reference

  • src/index.ts:508-525 (registration)
    Registration of the 'whmcs_add_ticket_note' tool via server.registerTool with name, schema, and handler.
    server.registerTool(
        'whmcs_add_ticket_note',
        {
            title: 'Add Ticket Note',
            description: 'Add an admin-only internal note to a ticket. Notes are not visible to the client and do not trigger email notifications.',
            inputSchema: {
                ticketid: z.number().describe('Ticket ID to add the note to'),
                message: z.string().describe('The note content'),
                markdown: z.boolean().optional().describe('Whether the message contains markdown formatting'),
            },
        },
        async (params) => {
            const result = await whmcsClient.addTicketNote(params);
            return {
                content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
            };
        }
    );
  • Input schema definition for the 'whmcs_add_ticket_note' tool, specifying ticketid (required number), message (required string), and markdown (optional boolean).
    inputSchema: {
        ticketid: z.number().describe('Ticket ID to add the note to'),
        message: z.string().describe('The note content'),
        markdown: z.boolean().optional().describe('Whether the message contains markdown formatting'),
    },
  • Handler function that receives the validated params and delegates to whmcsClient.addTicketNote(), then returns the JSON result.
    async (params) => {
        const result = await whmcsClient.addTicketNote(params);
        return {
            content: [{ type: 'text', text: JSON.stringify(result, null, 2) }],
        };
    }
  • The addTicketNote() method on WhmcsApiClient that sends the 'AddTicketNote' API action to WHMCS. Accepts ticketid, message, markdown, and optional attachments.
    /**
     * Add an admin-only internal note to a ticket
     * Notes are not visible to clients and do not trigger email notifications
     */
    async addTicketNote(params: {
        ticketid: number;
        message: string;
        markdown?: boolean;
        attachments?: Array<{ name: string; data: string }>;
    }) {
        return this.call<WhmcsApiResponse>('AddTicketNote', params);
    }
Behavior4/5

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

With no annotations, the description discloses essential behavioral traits: notes are not visible to clients and do not send emails. This provides adequate transparency for a simple mutation tool.

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 two concise sentences, front-loading the purpose and key behavior without extraneous content.

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?

The description covers purpose and behavioral constraints, but omits return value or success/failure indication. For a simple add, this is acceptable but not fully complete.

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?

Schema coverage is 100% with clear parameter descriptions. The tool description adds context about admin-only and no email but does not enhance parameter meaning beyond the schema.

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 tool adds an 'admin-only internal note' to a ticket, distinguishing it from client-visible replies. It specifies the key trait: notes are internal and do not trigger email notifications.

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?

The description implies usage for admin notes without client visibility, but it does not explicitly contrast with sibling tools like whmcs_add_ticket_reply or provide when-not conditions.

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