Skip to main content
Glama

HappyFox MCP by usefulapi

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/<ticket_number>/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. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations only supply destructiveHint=true and a title, so the description carries most of the burden. It adds meaningful context the annotations don't: the note is internal-only, and the call can also mutate status, priority, assignee, due date and tags — a non-obvious side effect that helps explain the destructive hint. It doesn't explain reasons for the destructive classification or reversibility.

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?

Two tight sentences, with the core purpose front-loaded before the side effects. The trailing REST endpoint reference is marginally useful context but not strictly necessary for an agent selecting the tool.

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 mutation tool with a nested custom_fields object, the schema covers parameter detail comprehensively and there is no output schema to explain. The description supplies purpose and side effects; it could note that mutating options are best avoided when merely annotating, but overall it is complete enough to call correctly.

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%, so the schema already documents all 12 parameters thoroughly (including the alert enum pattern and custom_fields conventions). The description's mention of alerting/status/priority/assignee/due date/tags merely summarizes existing schema fields without adding new syntax or meaning; baseline 3 is appropriate.

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+resource ('Add an internal note') and clarifies scope with 'never sent to the contact', which effectively distinguishes it from the sibling happyfox_add_staff_reply. It stops short of naming that sibling explicitly, so differentiation is implicit rather than explicit.

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 conveys that this is an internal-facing note with optional side effects, which implies when you'd use it (staff-only context) versus a customer reply. However, it never states prerequisites or explicitly names the alternative tool, leaving usage to inference.

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.