Skip to main content
Glama
effytech

Freshdesk MCP server

by effytech

list_solution_articles

Retrieve all solution articles from Freshdesk by specifying a folder ID using this tool, enabling efficient management and access to support documentation.

Instructions

List all solution articles in Freshdesk.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
folder_idYes

Implementation Reference

  • The primary handler function for the 'list_solution_articles' tool. It is decorated with @mcp.tool(), which registers it in the MCP framework. The function fetches articles from a specified Freshdesk solutions folder via the API and returns them as a list of dictionaries.
    @mcp.tool()
    async def list_solution_articles(folder_id: int)-> list[Dict[str, Any]]:
        """List all solution articles in Freshdesk."""
        solution_articles = []
        url = f"https://{FRESHDESK_DOMAIN}/api/v2/solutions/folders/{folder_id}/articles"
        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)
            for article in response.json():
                solution_articles.append(article)
        return solution_articles
Behavior2/5

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

With no annotations, the description carries full burden but only states it 'lists' articles without detailing behavior. It doesn't cover pagination, return format, permissions, rate limits, or whether it's read-only, which is insufficient for a tool with no structured safety hints.

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 front-loaded with the core action and resource, making it highly efficient and easy to parse.

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 no annotations, 0% schema coverage, and no output schema, the description is incomplete. It lacks parameter details, behavioral context, and output information, making it inadequate for a tool with one required parameter in a complex environment.

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?

Schema coverage is 0%, and the description doesn't mention the 'folder_id' parameter at all. It fails to explain what 'folder_id' means, its role in filtering articles, or valid values, leaving the parameter undocumented and unclear.

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 verb ('List') and resource ('all solution articles in Freshdesk'), making the purpose immediately understandable. It doesn't differentiate from siblings like 'list_solution_categories' or 'list_solution_folders', but the resource specificity is adequate.

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 siblings like 'view_solution_article' for single articles or 'search_tickets' for other resources, leaving the agent without context for tool selection.

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