Skip to main content
Glama

happyfox

List ticket custom fields

happyfox_list_ticket_custom_fields
Read-only

List ticket custom fields: id, type, choices (with choice ids), required flags and categories. Use the ids as t-cf-. HappyFox: GET /api/1.1/json/ticket_custom_fields/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. Beyond that, the description adds real behavioral value by disclosing the returned attributes (id, type, choices with choice ids, required flags, categories) and the id-prefix convention for downstream use — important given there is no output schema. It omits pagination and rate-limit behavior, keeping it short of a 5.

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 sentences, front-loaded with the resource and the concrete return fields. The trailing 'HappyFox: GET /api/1.1/json/ticket_custom_fields/.' is mildly redundant with the tool name but plausibly useful for tracing the endpoint, so it is not wasteful enough to penalize further.

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?

With no parameters and no output schema, the description usefully stands in for the missing return contract by enumerating the fields returned and the id convention. It does not address result size, pagination, or ordering, which is the only real gap for a list endpoint.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline of 4 applies. No parameter text is needed or expected here.

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 ('List ticket custom fields') and immediately distinguishes itself from the sibling happyfox_list_contact_custom_fields by scoping to tickets. An agent can tell exactly what this returns without opening anything else.

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?

Usage is implied rather than stated: the description tells the agent how to consume the ids ('Use the ids as t-cf-<id>'), which is a downstream use cue, but never says when to call this versus happyfox_update_ticket_custom_fields or why one would list fields. No prerequisites or exclusions are given.

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.