Skip to main content
Glama

Portal Help Tickets

obs_get_help_tickets
Read-onlyIdempotent

Retrieve and search your ITU help tickets by ID, title, or status to view ticket details, updates, and replies.

Instructions

List the user's help tickets. Search by ID, title or status. Returns id, title, unit, category, status, created_at, updated_at, url and has_reply. Selected rows are enriched from the help desk by default. Set include_details=false for a quick Portal-only read. Unavailable fields are null with missing_fields. Requires login.

Input Schema

NameRequiredDescriptionDefault
limitNo
queryNo
include_detailsNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed7 schema fields changedv1.2.1
    • addedInput schema / properties / include_details
      Added value: +{
      +  "default": false,
      +  "title": "Include Details",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / limit
      Added value: +{
      +  "default": 20,
      +  "title": "Limit",
      +  "type": "integer"
      +}
    • addedInput schema / properties / query
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "title": "Query"
      +}
    • removedOutput schema / additionalProperties
      Removed value: -true
    • addedOutput schema / properties
      Added value: +{
      +  "result": {
      +    "additionalProperties": true,
      +    "title": "Result",
      +    "type": "object"
      +  }
      +}
    • addedOutput schema / required
      Added value: +[
      +  "result"
      +]
    • changedOutput schema / title
      Previous value: -"obs_get_help_ticketsDictOutput"New value: +"obs_get_help_ticketsOutput"
  2. Addedv0.2.3

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint=false, so safety is covered; the description adds real context beyond that: login requirement, help-desk enrichment of selected rows, and null plus missing_fields for unavailable data. One wrinkle: it says rows are 'enriched from the help desk by default' while the schema default for include_details is false, which muddies the default behavior.

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?

Front-loaded with the core action and scoping, and every sentence is short and purposeful. The enumeration of return fields (id, title, unit, category, ...) is somewhat redundant given an output schema exists, costing a little density.

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 simple read tool with annotations and an output schema, the description covers login, enrichment mode, and missing-field handling adequately. It omits any mention of the limit/pagination knob and leaves the enrichment-vs-default inconsistency unresolved.

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 coverage is 0%, so the description carries the burden. It explains query (search by ID/title/status) and include_details (Portal-only read), but says nothing about limit or its default of 20, leaving one of three parameters undocumented.

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+resource ('List the user's help tickets') and enumerates the searchable dimensions (ID, title, status), which cleanly separates it from the singular sibling get_help_ticket. An agent can tell what this returns without opening the 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?

Gives a concrete when-to-use distinction for include_details (default enriched vs. 'quick Portal-only read') and a prerequisite ('Requires login'). It stops short of naming the alternative tool (get_help_ticket) for the single-ticket case, so it is clear context without explicit alternatives.

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