Skip to main content
Glama
effytech

Freshdesk MCP server

by effytech

view_ticket_field

Retrieve specific ticket field details in Freshdesk using the provided ticket field ID to streamline support ticket management and enhance operational efficiency.

Instructions

View a ticket field in Freshdesk.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ticket_field_idYes

Implementation Reference

  • The @mcp.tool()-decorated handler function that implements the view_ticket_field tool. It retrieves details of a specific ticket field by ID from the Freshdesk admin API.
    @mcp.tool()
    async def view_ticket_field(ticket_field_id: int) -> Dict[str, Any]:
        """View a ticket field in Freshdesk."""
        url = f"https://{FRESHDESK_DOMAIN}/api/v2/admin/ticket_fields/{ticket_field_id}"
        headers = {
            "Authorization": f"Basic {base64.b64encode(f'{FRESHDESK_API_KEY}:X'.encode()).decode()}"
        }
        async with httpx.AsyncClient() as client:
            response = await client.get(url, headers=headers)
            return response.json()
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It only states the action 'view' without explaining what is returned (e.g., field properties, metadata), potential errors (e.g., invalid ID), or system behavior (e.g., read-only operation, permissions required). This leaves significant gaps for an agent to understand how to use it effectively.

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?

The description is a single, direct sentence with no wasted words. It's appropriately sized for a simple tool and front-loaded with the core action, though its brevity contributes to gaps in other dimensions.

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

Completeness2/5

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

Given the complexity (a read operation with one parameter), lack of annotations, and no output schema, the description is incomplete. It doesn't cover what the tool returns, how to handle the parameter, or behavioral aspects like error cases, leaving the agent with insufficient context to use it correctly.

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

Parameters2/5

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

The description provides no information about the single parameter 'ticket_field_id'. With schema description coverage at 0%, the schema only gives a title and type, so the description fails to compensate by explaining what this ID is (e.g., numeric identifier, where to find it) or its format, making parameter usage unclear.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the verb 'view' and resource 'ticket field in Freshdesk', which gives a basic purpose. However, it's vague about what 'view' entails (e.g., retrieve details vs. display in UI) and doesn't distinguish it from sibling tools like 'get_ticket_fields' or 'view_ticket_summary', which could cause confusion.

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?

No guidance is provided on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a ticket_field_id), exclusions, or compare it to similar tools like 'get_ticket_fields' (which might list multiple fields) or 'view_ticket_summary' (which focuses on ticket summaries).

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

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/effytech/freshdesk_mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server