Skip to main content

An MCP server for Freshdesk

Project description

Freshdesk MCP Server

smithery badge

An MCP server implementation that integrates with Freshdesk, enabling AI models to interact with Freshdesk modules and perform various support operations.

Features

  • Freshdesk Integration: Seamless interaction with Freshdesk API endpoints
  • AI Model Support: Enables AI models to perform support operations through Freshdesk
  • Automated Ticket Management: Handle ticket creation, updates, and responses

Components

Tools

The server offers several tools for Freshdesk operations:

  • create_ticket: Create new support tickets

    • Inputs:
      • subject (string, required): Ticket subject
      • description (string, required): Ticket description
      • source (number, required): Ticket source code
      • priority (number, required): Ticket priority level
      • status (number, required): Ticket status code
      • email (string, optional): Email of the requester
      • requester_id (number, optional): ID of the requester
      • custom_fields (object, optional): Custom fields to set on the ticket
  • update_ticket: Update existing tickets

    • Inputs:
      • ticket_id (number, required): ID of the ticket to update
      • updates (object, required): Fields to update
  • delete_ticket: Delete a ticket

    • Inputs:
      • ticket_id (number, required): ID of the ticket to delete
  • search_tickets: Search for tickets based on criteria

    • Inputs:
      • query (string, required): Search query string
  • get_ticket_fields: Get all ticket fields

    • Inputs:
      • None
  • get_tickets: Get all tickets

    • Inputs:
      • page (number, optional): Page number to fetch
      • per_page (number, optional): Number of tickets per page
  • get_ticket: Get a single ticket

    • Inputs:
      • ticket_id (number, required): ID of the ticket to get

Getting Started

Installing via Smithery

To install freshdesk_mcp for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @effytech/freshdesk_mcp --client claude

Prerequisites

  • A Freshdesk account (sign up at freshdesk.com)
  • Freshdesk API key
  • uvx installed (pip install uv or brew install uv)

Configuration

  1. Generate your Freshdesk API key from the Freshdesk admin panel
  2. Set up your domain and authentication details

Usage with Claude Desktop

  1. Install Claude Desktop if you haven't already
  2. Add the following configuration to your claude_desktop_config.json:
"mcpServers": {
  "freshdesk-mcp": {
    "command": "uvx",
    "args": [
        "freshdesk-mcp"
    ],
    "env": {
      "FRESHDESK_API_KEY": "<YOUR_FRESHDESK_API_KEY>",
      "FRESHDESK_DOMAIN": "<YOUR_FRESHDESK_DOMAIN>"
    }
  }
}

Important Notes:

  • Replace YOUR_FRESHDESK_API_KEY with your actual Freshdesk API key
  • Replace YOUR_FRESHDESK_DOMAIN with your Freshdesk domain (e.g., yourcompany.freshdesk.com)

Example Operations

Once configured, you can ask Claude to perform operations like:

  • "Create a new ticket with subject 'Payment Issue for customer A101' and description as 'Reaching out for a payment issue in the last month for customer A101', where customer email is a101@acme.com and set priority to high"
  • "Update the status of ticket #12345 to 'Resolved'"
  • "List all high-priority tickets assigned to the agent John Doe"
  • "List previous tickets of customer A101 in last 30 days"

Testing

For testing purposes, you can start the server manually:

uvx freshdesk-mcp --env FRESHDESK_API_KEY=<your_api_key> --env FRESHDESK_DOMAIN=<your_domain>

Troubleshooting

  • Verify your Freshdesk API key and domain are correct
  • Ensure proper network connectivity to Freshdesk servers
  • Check API rate limits and quotas
  • Verify the uvx command is available in your PATH

License

This MCP server is licensed under the MIT License. See the LICENSE file in the project repository for full details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

freshdesk_mcp-0.2.0rc1.tar.gz (25.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

freshdesk_mcp-0.2.0rc1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file freshdesk_mcp-0.2.0rc1.tar.gz.

File metadata

  • Download URL: freshdesk_mcp-0.2.0rc1.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.16

File hashes

Hashes for freshdesk_mcp-0.2.0rc1.tar.gz
Algorithm Hash digest
SHA256 a92975948065a09a6ae578fb0fa5e8e1fe8d4594e000c89563cabfd11799c03f
MD5 93e9b4d89a3843560d7ab244ffa8a954
BLAKE2b-256 2be36d746729d96b063ecf067fedbe42655fb7dd30b2d0159be775345bd286e6

See more details on using hashes here.

File details

Details for the file freshdesk_mcp-0.2.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for freshdesk_mcp-0.2.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e1fffd9cb77cdf93c6d27a0d95d0372f60a3163a477fa07a9af08e7f3d97c58
MD5 09816df12b7c7f11d2f04e61a1f5cb59
BLAKE2b-256 fc3c0bd5a7886ff6925e358a850ca7d4bf158ff5d2d80e4eac140db487ee5448

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page