Freshdesk MCP Server

1# Freshdesk MCP Server
2[![smithery badge](https://smithery.ai/badge/@effytech/freshdesk_mcp)](https://smithery.ai/server/@effytech/freshdesk_mcp)
3 
4[![Trust Score](https://archestra.ai/mcp-catalog/api/badge/quality/effytech/freshdesk_mcp)](https://archestra.ai/mcp-catalog/effytech__freshdesk_mcp)
5 
6An MCP server implementation that integrates with Freshdesk, enabling AI models to interact with Freshdesk modules and perform various support operations.
7 
8## Features
9 
10- **Freshdesk Integration**: Seamless interaction with Freshdesk API endpoints
11- **AI Model Support**: Enables AI models to perform support operations through Freshdesk
12- **Automated Ticket Management**: Handle ticket creation, updates, and responses
13 
14## Components
15 
16### Tools
17 
18The server offers several tools for Freshdesk operations:
19 
20- `create_ticket`: Create new support tickets
21  - **Inputs**:
22    - `subject` (string, required): Ticket subject
23    - `description` (string, required): Ticket description
24    - `source` (number, required): Ticket source code
25    - `priority` (number, required): Ticket priority level
26    - `status` (number, required): Ticket status code
27    - `email` (string, optional): Email of the requester
28    - `requester_id` (number, optional): ID of the requester
29    - `custom_fields` (object, optional): Custom fields to set on the ticket
30    - `additional_fields` (object, optional): Additional top-level fields
31 
32- `update_ticket`: Update existing tickets
33  - **Inputs**:
34    - `ticket_id` (number, required): ID of the ticket to update
35    - `ticket_fields` (object, required): Fields to update
36 
37- `delete_ticket`: Delete a ticket
38  - **Inputs**:
39    - `ticket_id` (number, required): ID of the ticket to delete
40 
41- `search_tickets`: Search for tickets based on criteria
42  - **Inputs**:
43    - `query` (string, required): Search query string
44 
45- `get_ticket_fields`: Get all ticket fields
46  - **Inputs**:
47    - None
48 
49- `get_tickets`: Get all tickets
50  - **Inputs**:
51    - `page` (number, optional): Page number to fetch
52    - `per_page` (number, optional): Number of tickets per page
53 
54- `get_ticket`: Get a single ticket
55  - **Inputs**:
56    - `ticket_id` (number, required): ID of the ticket to get
57 
58- `get_ticket_conversation`: Get conversation for a ticket
59  - **Inputs**:
60    - `ticket_id` (number, required): ID of the ticket
61 
62- `create_ticket_reply`: Reply to a ticket
63  - **Inputs**:
64    - `ticket_id` (number, required): ID of the ticket
65    - `body` (string, required): Content of the reply
66 
67- `create_ticket_note`: Add a note to a ticket
68  - **Inputs**:
69    - `ticket_id` (number, required): ID of the ticket
70    - `body` (string, required): Content of the note
71 
72- `update_ticket_conversation`: Update a conversation
73  - **Inputs**:
74    - `conversation_id` (number, required): ID of the conversation
75    - `body` (string, required): Updated content
76 
77- `view_ticket_summary`: Get the summary of a ticket
78  - **Inputs**:
79    - `ticket_id` (number, required): ID of the ticket
80 
81- `update_ticket_summary`: Update the summary of a ticket
82  - **Inputs**:
83    - `ticket_id` (number, required): ID of the ticket
84    - `body` (string, required): New summary content
85 
86- `delete_ticket_summary`: Delete the summary of a ticket
87  - **Inputs**:
88    - `ticket_id` (number, required): ID of the ticket
89 
90- `get_agents`: Get all agents
91  - **Inputs**:
92    - `page` (number, optional): Page number
93    - `per_page` (number, optional): Number of agents per page
94 
95- `view_agent`: Get a single agent
96  - **Inputs**:
97    - `agent_id` (number, required): ID of the agent
98 
99- `create_agent`: Create a new agent
100  - **Inputs**:
101    - `agent_fields` (object, required): Agent details
102 
103- `update_agent`: Update an agent
104  - **Inputs**:
105    - `agent_id` (number, required): ID of the agent
106    - `agent_fields` (object, required): Fields to update
107 
108- `search_agents`: Search for agents
109  - **Inputs**:
110    - `query` (string, required): Search query
111 
112- `list_contacts`: Get all contacts
113  - **Inputs**:
114    - `page` (number, optional): Page number
115    - `per_page` (number, optional): Contacts per page
116 
117- `get_contact`: Get a single contact
118  - **Inputs**:
119    - `contact_id` (number, required): ID of the contact
120 
121- `search_contacts`: Search for contacts
122  - **Inputs**:
123    - `query` (string, required): Search query
124 
125- `update_contact`: Update a contact
126  - **Inputs**:
127    - `contact_id` (number, required): ID of the contact
128    - `contact_fields` (object, required): Fields to update
129 
130- `list_companies`: Get all companies
131  - **Inputs**:
132    - `page` (number, optional): Page number
133    - `per_page` (number, optional): Companies per page
134 
135- `view_company`: Get a single company
136  - **Inputs**:
137    - `company_id` (number, required): ID of the company
138 
139- `search_companies`: Search for companies
140  - **Inputs**:
141    - `query` (string, required): Search query
142 
143- `find_company_by_name`: Find a company by name
144  - **Inputs**:
145    - `name` (string, required): Company name
146 
147- `list_company_fields`: Get all company fields
148  - **Inputs**:
149    - None
150 
151## Getting Started
152 
153### Installing via Smithery
154 
155To install freshdesk_mcp for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@effytech/freshdesk_mcp):
156 
157```bash
158npx -y @smithery/cli install @effytech/freshdesk_mcp --client claude
159```
160 
161### Prerequisites
162 
163- A Freshdesk account (sign up at [freshdesk.com](https://freshdesk.com))
164- Freshdesk API key
165- `uvx` installed (`pip install uv` or `brew install uv`)
166 
167### Configuration
168 
1691. Generate your Freshdesk API key from the Freshdesk admin panel
1702. Set up your domain and authentication details
171 
172### Usage with Claude Desktop
173 
1741. Install Claude Desktop if you haven't already
1752. Add the following configuration to your `claude_desktop_config.json`:
176 
177```json
178"mcpServers": {
179  "freshdesk-mcp": {
180    "command": "uvx",
181    "args": [
182        "freshdesk-mcp"
183    ],
184    "env": {
185      "FRESHDESK_API_KEY": "<YOUR_FRESHDESK_API_KEY>",
186      "FRESHDESK_DOMAIN": "<YOUR_FRESHDESK_DOMAIN>"
187    }
188  }
189}
190```
191 
192**Important Notes**:
193- Replace `YOUR_FRESHDESK_API_KEY` with your actual Freshdesk API key
194- Replace `YOUR_FRESHDESK_DOMAIN` with your Freshdesk domain (e.g., `yourcompany.freshdesk.com`)
195 
196## Example Operations
197 
198Once configured, you can ask Claude to perform operations like:
199 
200- "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"
201- "Update the status of ticket #12345 to 'Resolved'"
202- "List all high-priority tickets assigned to the agent John Doe"
203- "List previous tickets of customer A101 in last 30 days"
204 
205 
206## Testing
207 
208For testing purposes, you can start the server manually:
209 
210```bash
211uvx freshdesk-mcp --env FRESHDESK_API_KEY=<your_api_key> --env FRESHDESK_DOMAIN=<your_domain>
212```
213 
214## Troubleshooting
215 
216- Verify your Freshdesk API key and domain are correct
217- Ensure proper network connectivity to Freshdesk servers
218- Check API rate limits and quotas
219- Verify the `uvx` command is available in your PATH
220 
221## License
222 
223This MCP server is licensed under the MIT License. See the LICENSE file in the project repository for full details.
224