Skip to main content
Glama

Add ticket note

create_ticket_note

Add a private or public note to a Freshservice ticket, including HTML content and attachments, to document internal updates or communicate with requesters.

Instructions

Add a note to a ticket (private by default).

Input Schema

NameRequiredDescriptionDefault
bodyYesNote content (HTML allowed)
privateNotrue (default): internal note for agents; false: visible to the requester
user_idNoUser ID to create the note as
incomingNoMark as coming from outside (requester side)
ticket_idYesTicket ID (the number shown as #INC-123 / #SR-123)
attachmentsNoLocal file paths to attach (max 15 files / 40 MB total). Only files inside the folders in FRESHSERVICE_ATTACHMENT_DIRS are allowed; attachments are refused until that is set
notify_emailsNoAgent emails to notify

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, openWorldHint=true, and destructiveHint=false, covering the safety profile. The description adds only the private-default behavior, which is already documented in the schema, and says nothing about notification side effects, deduplication, or attachment constraints beyond what structured fields provide.

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?

A single front-loaded sentence with no filler; the default behavior is stated up front. It is efficient, though terse for a 7-parameter mutation tool.

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?

With an output schema, full schema annotation, and safety annotations present, the description doesn't need to explain returns. However, for a mutation that can notify requesters and attach files, it omits key operational context such as note-versus-reply routing and notification 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?

Schema description coverage is 100% and each parameter is well documented (body HTML, private semantics, attachment limits, notify_emails). The description adds no parameter-level information beyond the schema, so baseline 3 applies.

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?

States a specific verb and resource ('Add a note to a ticket') plus a meaningful default ('private by default'), so the action is unambiguous. It does not distinguish itself from siblings like send_ticket_reply or update_ticket_conversation, which an agent could easily confuse it with.

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 'private by default' parenthetical implies an internal-only note, which hints at usage, but there is no explicit when-to-use or when-to-prefer-send_ticket_reply guidance. Usage must be inferred.

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

Deploy Server

Other Tools