Skip to main content
Glama
nks-hub

NKS osTicket MCP

by nks-hub

osticket_update_ticket

Update an osTicket ticket to change status, set or clear the due date, change the help topic, or add an internal staff note.

Instructions

Update a ticket: change status, set/clear due date, change help topic, and/or add an internal staff note.

Input Schema

NameRequiredDescriptionDefault
noteNoInternal note (staff-only, not emailed)
numberYesTicket number to update
statusNoNew status (open/closed/... or id)
dueDateNoDue date (ISO); null clears it
staffIdNoAgent the note is posted as (default: the configured API agent)
topicIdNoNew help topic id
noteTitleNoTitle for the internal note
statusCommentNoOptional comment logged with a status change

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.0
    • addedInput schema / properties / staffId
      Added value: +{
      +  "description": "Agent the note is posted as (default: the configured API agent)",
      +  "exclusiveMinimum": 0,
      +  "type": "integer"
      +}
  2. First observedv1.1.0

TDQS

B3.1/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden for a mutation tool. It adds a little context by noting the note is internal/staff-only and that dueDate can be cleared, but it does not disclose permissions, partial-update semantics, notification side effects, or response behavior.

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?

A single front-loaded sentence lists the tool's capabilities with no filler. It is appropriately sized and directly scannable.

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?

The description covers the main mutation categories and the schema fully documents parameters, but for a no-annotation mutation tool it omits important operational context such as authorization needs, whether updates are partial, and what the result looks like. It is adequate but with clear gaps.

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 8 parameters thoroughly. The description reinforces the main update operations but does not add syntax or constraints beyond the schema, which is the expected baseline when schema coverage is high.

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 gives a clear verb and resource ("Update a ticket") and enumerates the supported update categories: status, due date, help topic, and internal note. It is easy to distinguish from get/list/create/delete siblings, but it never explicitly differentiates itself from reply_ticket when adding a note.

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?

It implies the tool is for ticket updates but provides no explicit when-to-use guidance, prerequisites, or alternatives. In particular, it does not say when to use this versus osticket_reply_ticket for customer-facing replies versus internal staff notes.

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