🚀 Freshdesk MCP 服务器
一个与 Freshdesk 集成的 MCP 服务器实现，可让 AI 模型与 Freshdesk 模块交互，执行各类支持操作，极大提升支持工作的效率和智能化水平。
✨ 主要特性
- Freshdesk 集成：与 Freshdesk API 端点无缝交互，确保数据传输的高效与稳定。
- AI 模型支持：允许 AI 模型通过 Freshdesk 执行支持操作，为支持流程注入智能动力。
- 自动化工单管理：处理工单的创建、更新和响应，节省人力成本，提高工单处理速度。
📦 安装指南
使用 Smithery 进行安装
# 使用以下命令在终端中运行安装脚本
smithery install @effytech/freshdesk-mcp
手动安装
- 下载并提取压缩包：
wget https://example.com/freshdesk-mcp.zip && unzip freshdesk-mcp.zip - 安装依赖项：
npm install - 启动服务器：
node index.js
💻 使用示例
基础用法
创建工单
curl -X POST http://localhost:3000/api/tickets \
-H "Content-Type: application/json" \
-d '{"subject":"问题报告","description":"遇到一个严重的问题。"}'
更新工单状态
curl -X PUT http://localhost:3000/api/tickets/123/status \
-H "Content-Type: application/json" \
-d '{"status":2}'
📚 详细文档
组件 - 工具
该服务器提供了多个用于 Freshdesk 操作的工具：
| 工具名称 | 功能 | 输入参数 |
|---|---|---|
create_ticket |
创建新支持工单 | subject (字符串，必需)：工单主题description (字符串，必需)：工单描述source (数字，必需)：工单来源代码priority (数字，必需)：工单优先级级别status (数字，必需)：工单状态代码email (字符串，可选)：请求者的电子邮件requester_id (数字，可选)：请求者 IDcustom_fields (对象，可选)：工单自定义字段 |
update_ticket |
更新现有工单 | ticket_id (数字，必需)：要更新的工单 IDupdates (对象，必需)：要更新的字段 |
delete_ticket |
删除一个工单 | ticket_id (数字，必需)：要删除的工单 ID |
search_tickets |
根据条件搜索工单 | query (字符串，必需)：搜索查询字符串 |
get_ticket_fields |
获取所有工单字段 | 无 |
get_tickets |
获取所有工单 | page (数字，可选)：要获取的页码per_page (数字，可选)：每页显示的工单数量 |
get_ticket |
获取一个单一工单 | ticket_id (数字，必需)：要获取的工单 ID |
先决条件
- Node.js 14 或更高版本
- npm 6 或更高版本
- Freshdesk 账户及 API 访问权限
技术要求
| 属性 | 详情 |
|---|---|
| 端口 | 默认为 3000 |
| 协议 | HTTP/HTTPS |
| 支持的格式 | JSON |
配置
示例配置文件（config.json）
{
"freshdesk": {
"url": "https://your-subdomain.freshdesk.com",
"api_key": "your_api_key"
},
"mcp": {
"port": 3000,
"host": "localhost"
}
}
设置环境变量
export FRESHDESK_URL="https://your-subdomain.freshdesk.com"
export FRESHDESK_API_KEY="your_api_key"
测试
单元测试
运行以下命令执行单元测试：
npm test
集成测试
运行以下命令执行集成测试：
npm run integration-test
故障排除
- 端口冲突：确保没有其他服务占用
3000端口。 - 连接问题：检查网络连接和 API 服务状态。
- 配置错误：核实
config.json文件是否正确。
常见问题解答
-
如何更改默认端口？
- 修改
config.json中的port参数。
- 修改
-
无法连接到 Freshdesk？
- 检查 API URL 和密钥是否正确。
🔧 技术细节
该服务器基于 Node.js 构建，使用 HTTP/HTTPS 协议与 Freshdesk API 进行通信。默认监听 3000 端口，支持 JSON 格式的数据交互。通过封装 Freshdesk API 的各类操作，提供了一系列方便的工具函数，供 AI 模型调用，实现与 Freshdesk 系统的集成和工单管理自动化。
📄 许可证
此 MCP 服务器根据 MIT 许可证发布。有关详细信息，请参阅项目仓库中的 LICENSE 文件。
⚠️ 重要提示
- 在生产环境中，请确保 API 密钥的安全性。
- 定期更新 API 密钥以增强安全性。
- 配置文件应置于安全的位置，避免未授权访问。