Skip to main content
Glama

Zammad MCP by usefulapi

Add internal note

zammad_add_internal_note
Destructive

WRITE: add an INTERNAL note (visible to agents only, never e-mailed to the customer) to ONE ticket. Needs an agent's token (a customer's token is refused, because Zammad would make the note public). The ticket's other data is not changed. POST /api/v1/ticket_articles with type=note, internal=true.

Input Schema

NameRequiredDescriptionDefault
bodyYesNote text (plain text).
subjectNoOptional note subject (one line).
ticket_idYesZammad ticket id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Adds real context the annotations do not carry: the agent-token requirement (customer tokens are refused and why), the fact that the ticket's other data is untouched, and the exact endpoint/payload shape. One tension: annotations declare destructiveHint=true while the text says existing ticket data is unchanged — a mild mismatch about destructiveness, though both agree this is a write.

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?

Front-loads 'WRITE' and 'INTERNAL', then auth precondition, then side-effect, then endpoint. Every clause carries information; nothing is padding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 3-parameter write with no output schema and full annotation coverage, the description supplies the auth precondition, the visibility semantics, the non-mutation guarantee and the wire format. Nothing needed to call it correctly is missing.

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 ticket_id, body and subject are already documented with types and length bounds. The description only adds the 'ONE ticket' cardinality constraint and the note/public distinction, so baseline 3 is appropriate.

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?

States a specific verb and resource ('add an INTERNAL note ... to ONE ticket') with the key qualifier that distinguishes it from a customer reply. An agent can immediately tell this apart from zammad_reply_to_ticket without opening either schema.

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?

The description makes the use case unambiguous: visible to agents only, never e-mailed to the customer, which implicitly routes customer-facing messages to reply_to_ticket. It stops short of naming that sibling explicitly, so the exclusion is inferable rather than spelled out.

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.