Freshdesk MCP

🚀 Freshdesk MCP Server

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

🚀 Quick Start

Installation Methods

Install via Smithery

# Run the installation script in the terminal using the following command
smithery install @effytech/freshdesk-mcp

Manual Installation

1. Download and extract the compressed package:

   wget https://example.com/freshdesk-mcp.zip && unzip freshdesk-mcp.zip
   

2. Install dependencies:

   npm install
   

3. Start the server:

   node index.js
   

✨ Features

• Freshdesk Integration: Seamlessly interact with Freshdesk API endpoints.
• AI Model Support: Allow AI models to perform support operations through Freshdesk.
• Automated Ticket Management: Handle ticket creation, updates, and responses.

📦 Components

Tools

The server provides multiple tools for Freshdesk operations:

• create_ticket: Create a new support ticket.

  • Input:
    • 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): Requester's email.
    • requester_id (number, optional): Requester ID.
    • custom_fields (object, optional): Custom ticket fields.

• update_ticket: Update an existing ticket.

  • Input:
    • ticket_id (number, required): ID of the ticket to update.
    • updates (object, required): Fields to update.

• delete_ticket: Delete a ticket.

  • Input:
    • ticket_id (number, required): ID of the ticket to delete.

• search_tickets: Search for tickets based on conditions.

  • Input:
    • query (string, required): Search query string.

• get_ticket_fields: Get all ticket fields.

  • Input:
    • None.

• get_tickets: Get all tickets.

  • Input:
    • page (number, optional): Page number to retrieve.
    • per_page (number, optional): Number of tickets to display per page.

• get_ticket: Get a single ticket.

  • Input:
    • ticket_id (number, required): ID of the ticket to retrieve.

📚 Documentation

Prerequisites

• Node.js version 14 or higher.
• npm version 6 or higher.
• A Freshdesk account and API access.

Technical Requirements

• Port: Default is 3000.
• Protocol: HTTP/HTTPS.
• Supported format: JSON.

Configuration

Example Configuration File (config.json)

{
  "freshdesk": {
    "url": "https://your-subdomain.freshdesk.com",
    "api_key": "your_api_key"
  },
  "mcp": {
    "port": 3000,
    "host": "localhost"
  }
}

Set Environment Variables

export FRESHDESK_URL="https://your-subdomain.freshdesk.com"
export FRESHDESK_API_KEY="your_api_key"

Notes

⚠️ Important Note

• Ensure the security of the API key in a production environment.
• Regularly update the API key to enhance security.
• Place the configuration file in a secure location to prevent unauthorized access.

Example Operations

Create a Ticket

curl -X POST http://localhost:3000/api/tickets \
     -H "Content-Type: application/json" \
     -d '{"subject":"Problem Report","description":"Encountered a serious problem."}'

Update Ticket Status

curl -X PUT http://localhost:3000/api/tickets/123/status \
     -H "Content-Type: application/json" \
     -d '{"status":2}'

Testing

Unit Tests

Run the following command to perform unit tests:

npm test

Integration Tests

Run the following command to perform integration tests:

npm run integration-test

Troubleshooting

1. Port Conflict: Ensure that no other service is using port 3000.
2. Connection Issues: Check the network connection and API service status.
3. Configuration Errors: Verify the correctness of the config.json file.

Frequently Asked Questions

• How to change the default port?

  • Modify the port parameter in config.json.

• Unable to connect to Freshdesk?

  • Check the API URL and key for correctness.

📄 License

This MCP server is released under the MIT License. For more details, please refer to the LICENSE file in the project repository.