Skip to main content
Glama

happyfox

Add a private note to a ticket

happyfox_add_private_note
Destructive

Add an internal note (never sent to the contact), optionally alerting agents and changing status, priority, assignee, due date or tags. HappyFox: POST /api/1.1/json/ticket//staff_pvtnote/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
htmlNoNote in HTML.
tagsNoTags to set, as a comma-separated string.
alertNoSend a private alert: `s` = all subscribers, `c` = all agents in the ticket's category, or an agent id.
staffYesThe agent adding the note (happyfox_list_staff) id.
statusNoNew status id (happyfox_list_statuses).
assigneeNoAgent id to assign the ticket to (from happyfox_list_staff); null to unassign.
due_dateNoDue date, yyyy-mm-dd or dd/mm/yyyy.
priorityNoNew priority id (happyfox_list_priorities).
plaintextNoNote in plain text.
time_spentNoMinutes to add to the ticket's time spent (some categories require it).
custom_fieldsNoCustom field values keyed "t-cf-<id>". Ticket fields (ids from happyfox_list_ticket_custom_fields); compulsory-on-completion fields are required when closing. Values: text = string, number = number, dropdown = choice id, multiple choice = array of choice ids, date = yyyy-mm-dd.
ticket_numberYesThe ticket NUMBER (the `id` field, e.g. 3 for #DC00000003) — not the prefixed display id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations supply only destructiveHint=true; the description adds real behavioral context by disclosing the note is internal-only (never visible to the contact) and that the call can also alert agents and rewrite status, priority, assignee, due date and tags. That mutation scope corroborates the destructive hint, though reversibility and alert semantics are not spelled out.

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?

Two tight sentences: purpose and the critical internal-only distinction come first, side effects second, endpoint last. No filler.

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?

For a 12-parameter, nested-object mutation tool with no output schema, the description covers purpose, the internal-only nature and the full set of side effects. It omits return behavior and any note on compulsory custom fields on close (left to the schema), leaving a minor gap.

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% across 12 parameters, so the schema already documents html/plaintext, alert codes, ids, due-date formats and custom_fields. The description only recaps that alert/status/priority/assignee/due_date/tags can be set and adds no syntax or value beyond the schema, which is the expected baseline here.

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?

Specific verb+resource (add an internal/private note to a ticket) with the key qualifier "never sent to the contact," which immediately separates it from the customer-facing happyfox_add_staff_reply. It also enumerates the secondary mutations (status, priority, assignee, due date, tags) so an agent knows the call does more than append text.

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?

"Internal note (never sent to the contact)" gives clear selection context against the reply sibling, but the alternative is not named and there are no explicit exclusions or prerequisites. This is clear context without routing language.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.