Skip to main content
Glama

ninja_add_ticket_comment

Add a plain text or HTML comment to a ticket, with options for public visibility and time tracking.

Instructions

Add a comment to a ticket.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ticketIdYesTicket ID
bodyYesComment body (plain text)
htmlBodyNoComment body as HTML
publicNoWhether the comment is public (visible to end users)
timeTrackedNoTime tracked in seconds
technicianUidNoUID of the technician adding the comment

Implementation Reference

  • Tool definition and input schema for 'ninja_add_ticket_comment'. Defines name, description, and inputSchema with required fields: ticketId (number) and body (string), plus optional fields: htmlBody, public, timeTracked, technicianUid.
    tool: {
      name: 'ninja_add_ticket_comment',
      description: 'Add a comment to a ticket.',
      inputSchema: {
        type: 'object',
        required: ['ticketId', 'body'],
        properties: {
          ticketId: { type: 'number', description: 'Ticket ID' },
          body: { type: 'string', description: 'Comment body (plain text)' },
          htmlBody: { type: 'string', description: 'Comment body as HTML' },
          public: {
            type: 'boolean',
            description: 'Whether the comment is public (visible to end users)',
          },
          timeTracked: { type: 'number', description: 'Time tracked in seconds' },
          technicianUid: { type: 'string', description: 'UID of the technician adding the comment' },
        },
      },
    },
  • Handler function for 'ninja_add_ticket_comment'. Extracts ticketId from args, passes remaining body fields to a POST request to /ticketing/ticket/{ticketId}/comment via the NinjaOneClient.
      handler: async ({ ticketId, ...body }, client: NinjaOneClient) =>
        client.post(`/ticketing/ticket/${ticketId}/comment`, body),
    },
  • The tool is registered as part of the ticketingTools array exported from this module, which is then spread into the ALL_TOOLS array in src/tools/index.ts.
    export const ticketingTools: ToolDef[] = [
Behavior1/5

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

The description provides no behavioral details beyond the basic action. No annotations are present. The tool may have side effects (e.g., updating ticket status, sending notifications) but none are disclosed.

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, concise sentence with no wasted words. While minimal, it is appropriately sized for a simple action. Could benefit from slight elaboration.

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?

With 6 parameters, no output schema, and no annotations, the description is insufficiently complete. It fails to clarify parameter interdependencies (e.g., body vs htmlBody), required permissions, or expected behavior.

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% parameter description coverage, so the schema already documents each parameter. The description adds no additional meaning or contextual guidance beyond what is in the schema.

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?

The description 'Add a comment to a ticket.' clearly states the action (add) and resource (comment to a ticket), distinguishing it from other ticket-related tools like ninja_create_ticket or ninja_get_ticket. However, it does not explicitly state that the ticket must already exist.

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, nor are any prerequisites (e.g., ticket must exist) mentioned. The description lacks context for appropriate usage.

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/Allied-Business-Solutions/ninjaone-mcp'

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