使用说明
Freshdesk MCP 服务器
一个与Freshdesk集成的MCP服务器实现,使人工智能模型能够与Freshdesk模块进行交互并执行各种支持操作。
特点/特性
- Freshdesk 集成与Freshdesk API终端实现无缝交互
- AI模型支持使AI模型能够通过Freshdesk执行支持操作
- 自动化票务管理处理工单的创建、更新和回复
组件
工具
该服务器为Freshdesk操作提供了多种工具:
-
create_ticket创建新的支持工单- 输入:
subject(字符串,必填):工单主题description(字符串,必填):票据描述source(数字,必填):票务源代码priority(数字,必填):工单优先级级别status(数字,必填):票务状态代码email(字符串,可选):请求者的电子邮件requester_id(数字,可选):请求者的IDcustom_fields(对象,可选):要在票上设置的自定义字段additional_fields(对象,可选):额外的顶级字段
- 输入:
-
update_ticket更新现有工单- 输入项:
ticket_id(数字,必填):要更新的票据的IDticket_fields(对象,必需): 要更新的字段
- 输入项:
-
delete_ticket删除一个工单/票证- 输入:
ticket_id(数字,必填):要删除的票据的ID
- 输入:
-
search_tickets根据条件搜索票务- 输入:
query(字符串,必填):搜索查询字符串
- 输入:
-
get_ticket_fields获取所有票务字段- 输入:
- 无
- 输入:
-
get_tickets获取所有票据- 输入:
page(数字,可选):要获取的页码per_page(数字,可选):每页的票数
- 输入:
-
get_ticket获取一张单程票- 输入:
ticket_id(数字,必填):要获取的票据的ID
- 输入:
-
get_ticket_conversation获取工单的对话记录- 输入:
ticket_id(数字,必填):票务的ID
- 输入:
-
create_ticket_reply回复工单- 输入:
ticket_id(数字,必填):票据的IDbody(字符串,必填):回复内容
- 输入:
-
create_ticket_note在工单中添加备注- 输入项:
ticket_id(数字,必填):票的IDbody(字符串,必填):备注内容
- 输入项:
-
update_ticket_conversation更新对话- 输入:
conversation_id(数字,必填):对话的IDbody(字符串,必填):更新后的内容
- 输入:
-
view_ticket_summary获取工单的摘要- 输入项:
ticket_id(数字,必填):票据的ID
- 输入项:
-
update_ticket_summary更新工单摘要- 输入:
ticket_id(数字,必填):票据的IDbody(字符串,必填):新的摘要内容
- 输入:
-
delete_ticket_summary删除票务摘要- 输入:
ticket_id(数字,必填):票务ID
- 输入:
-
get_agents获取所有代理- 输入项:
page(数字,可选):页码per_page(数字,可选):每页显示的代理数量
- 输入项:
-
view_agent获取单个代理- 输入:
agent_id(数字,必填):代理的ID
- 输入:
-
create_agent创建一个新的代理- 输入:
agent_fields(对象,必需):代理详情
- 输入:
-
update_agent更新一个代理- 输入:
agent_id(数字,必填):代理的IDagent_fields(对象,必需): 要更新的字段
- 输入:
-
search_agents寻找代理商- 输入:
query(字符串,必填): 搜索查询
- 输入:
-
list_contacts获取所有联系人- 输入:
page(数字,可选):页码per_page(数字,可选):每页的联系人数量
- 输入:
-
get_contact获取单个联系人- 输入:
contact_id(数字,必填):联系人的ID
- 输入:
-
search_contacts搜索联系人- 输入:
query(字符串,必填):搜索查询
- 输入:
-
update_contact更新联系人- 输入:
contact_id(数字,必填):联系人的IDcontact_fields(对象,必需): 需要更新的字段
- 输入:
-
list_companies获取所有公司- 输入:
page(数字,可选):页码per_page(数字,可选):每页显示的公司数量
- 输入:
-
view_company获取一家公司- 输入:
company_id(数字,必填):公司ID
- 输入:
-
search_companies搜索公司- 输入:
query(字符串,必填):搜索查询
- 输入:
-
find_company_by_name按名称查找公司- 输入:
name(字符串,必填):公司名称
- 输入:
-
list_company_fields获取所有公司字段- 输入:
- 无
- 输入:
入门指南/开始使用
通过Smithery进行安装
通过……自动为Claude Desktop安装freshdesk_mcp “Smithery”可以翻译为“铁匠铺”或“锻造工坊”。这个词汇直接关联到与金属加工,尤其是锻造相关的场所或活动:
npx -y @smithery/cli install @effytech/freshdesk_mcp --client claude
先决条件
- 一个Freshdesk账户(注册地址: freshdesk.com(可译为“Freshdesk官网”或保持原样作为网址))
- Freshdesk API密钥
uvx安装了(pip install uv或者brew install uv)
配置
- 在Freshdesk管理面板中生成您的Freshdesk API密钥
- 设置您的域名和身份验证详情
与Claude桌面版的使用
- 如果你还没有安装,现在请安装Claude Desktop
- 将以下配置添加到您的
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>"
}
}
}
重要注意事项:
- 替换
YOUR_FRESHDESK_API_KEY使用您实际的Freshdesk API密钥 - 替换
YOUR_FRESHDESK_DOMAIN使用您的 Freshdesk 域名(例如。,yourcompany.freshdesk.com)
示例操作
配置完成后,您可以要求Claude执行以下操作:
- “创建一个新工单,主题为‘客户A101的支付问题’,描述为‘联系关于客户A101上个月出现的支付问题’,客户邮箱为a101@acme.com,并将优先级设置为高。”
- “将工单#12345的状态更新为‘已解决’”
- “列出分配给客服人员John Doe的所有高优先级工单”
- “列出客户A101在过去30天内的历史工单”
测试
为了测试目的,您可以手动启动服务器:
uvx freshdesk-mcp --env FRESHDESK_API_KEY=<your_api_key> --env FRESHDESK_DOMAIN=<your_domain>
故障排除
- 验证您的Freshdesk API密钥和域名是否正确
- 确保与Freshdesk服务器建立适当的网络连接
- 检查API速率限制和配额
- 验证
uvx该命令在您的 PATH 中可用
许可证
此MCP服务器遵循MIT许可证授权。有关完整详情,请参阅项目仓库中的LICENSE文件。