Skip to main content
Glama
effytech

Freshdesk MCP server

by effytech

create_solution_article

Generate a solution article in Freshdesk by specifying a folder ID and article fields, streamlining support documentation creation and management.

Instructions

Create a solution article in Freshdesk.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
article_fieldsYes
folder_idYes

Implementation Reference

  • The main handler function for the 'create_solution_article' tool. It creates a solution article in Freshdesk by posting to the API endpoint with the provided folder_id and article_fields. Includes basic validation for required fields: title, status, description.
    @mcp.tool()
    async def create_solution_article(folder_id: int, article_fields: Dict[str, Any])-> Dict[str, Any]:
        """Create a solution article in Freshdesk."""
        if not article_fields.get("title") or not article_fields.get("status") or not article_fields.get("description"):
            return {"error": "Title, status and description are required"}
        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.post(url, headers=headers, json=article_fields)
            return response.json()
  • The @mcp.tool() decorator registers the create_solution_article function as an MCP tool.
    @mcp.tool()
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 states 'Create' which implies a write operation, but doesn't specify required permissions, whether it's idempotent, what happens on failure, or the expected response format. This leaves significant gaps for a mutation tool.

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, efficient sentence with no wasted words. It's appropriately sized for a basic creation tool and front-loads the essential action and resource.

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 mutation tool with 2 parameters, 0% schema coverage, no annotations, and no output schema, the description is inadequate. It lacks details on parameter usage, behavioral expectations, and output, making it incomplete for reliable agent invocation.

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 description coverage is 0%, so the description must compensate but adds no parameter information. It doesn't explain what 'article_fields' should contain (e.g., title, content) or the purpose of 'folder_id', leaving both parameters completely undocumented beyond their names in the schema.

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 ('Create') and resource ('a solution article in Freshdesk'), making the purpose immediately understandable. It distinguishes from siblings like 'create_solution_category' or 'create_ticket' by specifying the article type, though it doesn't explicitly contrast with them.

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 like needing a folder_id, nor does it differentiate from similar creation tools like 'create_solution_category' or 'update_solution_article' for editing existing articles.

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