Skip to main content
Glama

Get Helpcentre Getticket ID

hgr_get_helpcentre_getticket_id
Read-onlyIdempotent

Dedicated HGRApi tool for GET api/HelpCentre/GetTicket/{id}. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Reads one authenticated CRM support ticket by visible ticket id. Domain: support. Entity: support_ticket. Operation: get_exact. Scope: authenticated_user. Use when: Use when the user asks about an existing support ticket and provides the visible TCK-* ticket reference. Input: [FromRoute] id: string. Legacy numeric ids are not supported. Output: Returns ticket detail including visible id/number, state, priority, dates, customer and messages. Search terms: helpcentre getticket id.

Input Schema

NameRequiredDescriptionDefault
idYesHGRApi route parameter id.

Output Schema

NameRequiredDescriptionDefault

No arguments

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?

Annotations already declare readOnly/idempotent/non-destructive/openWorld, and the description adds genuinely new behavior: authenticated_user scope and the rejection of legacy numeric ids. That is useful context beyond the structured fields, though no rate-limit or error behavior is described.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The labeled fields (Purpose/Domain/Entity/Operation/Scope/Use when/Input/Output) are front-loaded and scannable, but boilerplate like 'Dedicated HGRApi tool for GET api/...', the 'not a generic endpoint caller' disclaimer, and 'Search terms' pad the definition without adding selectable information.

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 single-parameter read with an output schema, everything an agent needs is present: trigger condition, id format constraint, scope, and a short note on the returned payload. Nothing material is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with one required string, so the schema does most of the work. The description still adds meaningful semantics: the id is a route parameter and must be a visible TCK-* reference rather than a legacy numeric id.

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+scope: reads one authenticated CRM support ticket by visible ticket id, with 'Operation: get_exact' and 'Entity: support_ticket'. This distinguishes it from hgr_list_support_tickets and hgr_get_support_ticket by noting it reads a single ticket by visible reference.

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 'Use when' clause gives a concrete trigger (user asks about an existing ticket and supplies a TCK-* reference), and it explicitly excludes legacy numeric ids. It does not, however, contrast against the similarly named sibling hgr_get_support_ticket, leaving one plausible ambiguity.

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.

Resources