Skip to main content
Glama
effytech

Freshdesk MCP server

by effytech

list_groups

Retrieve all groups from Freshdesk using pagination, enabling efficient management and organization of support team structures.

Instructions

List all groups in Freshdesk.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
per_pageNo

Implementation Reference

  • The primary handler function for the 'list_groups' tool. It fetches groups from the Freshdesk API with optional pagination parameters (page and per_page). The @mcp.tool() decorator registers it with the MCP server. The function signature provides the implicit input schema.
    async def list_groups(page: Optional[int] = 1, per_page: Optional[int] = 30)-> list[Dict[str, Any]]:
        """List all groups in Freshdesk."""
        url = f"https://{FRESHDESK_DOMAIN}/api/v2/groups"
        headers = {
            "Authorization": f"Basic {base64.b64encode(f'{FRESHDESK_API_KEY}:X'.encode()).decode()}"
        }
        params = {
            "page": page,
            "per_page": per_page
        }
        async with httpx.AsyncClient() as client:
            response = await client.get(url, headers=headers, params=params)
            return response.json()
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It only states what the tool does ('List all groups') but provides no information about pagination behavior (despite pagination parameters in the schema), rate limits, authentication requirements, or what format the output takes. This is inadequate for a tool with parameters.

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 extremely concise - a single sentence that states the core purpose. There's no wasted language or unnecessary elaboration. It's appropriately sized for a simple list operation.

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?

For a tool with 2 parameters, 0% schema description coverage, no annotations, and no output schema, the description is insufficient. It doesn't explain the pagination parameters, return format, or behavioral characteristics. While concise, it leaves too many gaps for the agent to understand how to properly use this tool.

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

Parameters1/5

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

Schema description coverage is 0%, meaning neither parameter has descriptions in the schema. The tool description provides no information about the 2 parameters (page and per_page), their purpose, default values, or how they affect the listing behavior. The description fails to compensate for the complete lack of schema documentation.

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 clearly states the action ('List all groups') and resource ('in Freshdesk'), providing a specific verb+resource combination. However, it doesn't distinguish this tool from other list tools like 'list_companies' or 'list_contacts' beyond the resource type.

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 about when to use this tool versus alternatives. While the description implies it's for listing groups, there's no mention of when to use this versus 'view_group' or how it relates to group management tools like 'create_group' or 'update_group'.

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