使用说明
Freshservice MCP服务器
概述
强大的MCP(模型上下文协议)服务器实现,与Freshservice无缝集成,使AI模型能够与Freshservice模块交互并执行各种IT服务管理操作。此集成桥使您的AI助手能够管理和解决IT服务问题,简化您的支持工作流程。
主要特点
- 企业级Freshservice集成:与Freshservice API端点进行直接、安全的通信
- AI模型兼容性:使Claude和其他AI模型能够通过Freshservice执行服务台操作
- 自动化ITSM管理:高效处理工单创建、更新、响应和资产管理
- 工作流加速:减少对日常IT服务任务的人工干预
支持的Freshservice模块
此MCP服务器目前支持各种Freshservice模块的操作:
- 门票
- 变化
- 对话
- 产品
- 请求者
- 代理
- 代理组
- 请求者组
- 罐装回复
- 屏蔽响应文件夹
- 工作区
- 解决方案类别
- 解决方案文件夹
- 解决方案文章
组件和工具
服务器为Freshservice操作提供了一个全面的工具包:
票务管理
| 工具 | 说明 | 关键参数 |
|---|---|---|
create_ticket |
创建新的服务票 | subject, description, source, priority, status, email |
update_ticket |
更新现有票证 | ticket_id, updates |
delete_ticket |
删除票证 | ticket_id |
filter_tickets |
查找符合条件的门票 | query |
get_ticket_fields |
检索票字段定义 | 无 |
get_tickets |
按页码列出所有门票 | page, per_page |
get_ticket_by_id |
检索单程票详细信息 | ticket_id |
变更管理
| 工具 | 说明 | 关键参数 |
|---|---|---|
get_changes |
按页码列出所有更改 | page, per_page, query |
filter_changes |
使用高级查询筛选更改 | query, page, per_page |
get_change_by_id |
检索单个更改详细信息 | change_id |
create_change |
创建新的变更请求 | requester_id, subject, description, priority, impact, status, risk, change_type |
update_change |
更新现有更改 | change_id, change_fields |
close_change |
关闭更改并解释结果 | change_id, change_result_explanation |
delete_change |
删除更改 | change_id |
get_change_tasks |
获取需要更改的任务 | change_id |
create_change_note |
添加注释以进行更改 | change_id, body |
🚨 重要提示:用于筛选的查询语法
使用时 get_changes 或 filter_changes 随着 query 参数, 查询字符串必须用双引号括起来 为了使Freshservice API正常工作:
✅ 正确: "status:3", "approval_status:1 AND status:<6"
❌ 错误: status:3 (将导致500内部服务器错误)
常见查询示例:
"status:3"-等待批准的更改"approval_status:1"-已批准的变更"approval_status:1 AND status:<6"-未关闭的已批准更改"planned_start_date:>'2025-07-14'"-特定日期后开始的更改"status:3 AND priority:1"-等待批准的高优先级变更
入门指南
通过Smithery安装
要通过Smithery自动安装freshservice_mcp:
npx -y @smithery/cli install @effytech/freshservice_mcp --client claude
先决条件
- Freshservice帐户(注册地址: freshservice.com)
- Freshservice API密钥
uvx已安装(pip install uv或brew install uv)
配置
-
从管理面板生成您的Freshservice API密钥:
- 导航到配置文件设置→ API设置
- 复制API密钥进行配置
-
设置您的域和身份验证详细信息,如下所示
使用Claude Desktop
- 从安装Claude Desktop 官方网站
- 将以下配置添加到您的
claude_desktop_config.json:
"mcpServers": {
"freshservice-mcp": {
"command": "uvx",
"args": [
"freshservice-mcp"
],
"env": {
"FRESHSERVICE_APIKEY": "<YOUR_FRESHSERVICE_APIKEY>",
"FRESHSERVICE_DOMAIN": "<YOUR_FRESHSERVICE_DOMAIN>"
}
}
}
重要:替换 <YOUR_FRESHSERVICE_APIKEY> 使用您的实际API密钥和 <YOUR_FRESHSERVICE_DOMAIN> 使用您的域名(例如。, yourcompany.freshservice.com)
示例操作
配置后,您可以要求Claude执行以下操作:
门票:
- “创建主题为“营销部门的网络连接问题”和描述为“营销区域的用户无法连接到Wi-Fi”的新事件单,将优先级设置为高”
- “列出过去24小时内报告的所有重大事件”
- “将票证#12345状态更新为已解决”
变化:
- “为下周二凌晨2点的计划服务器维护创建更改请求”
- 将变更请求#45678的状态更新为“已批准”
- “关闭更改#5092,结果解释为‘已成功部署到生产环境。所有测试均已通过。’”
- “列出所有待处理的更改”
其他操作:
- “显示资产标签为'LT-2023-087'的笔记本电脑的资产详细信息”
- “创建一篇关于密码重置过程的解决方案文章”
测试
出于测试目的,您可以手动启动服务器:
uvx freshservice-mcp --env FRESHSERVICE_APIKEY=<your_api_key> --env FRESHSERVICE_DOMAIN=<your_domain>
故障排除
- 验证您的Freshservice API密钥和域是否正确
- 确保与Freshservice服务器的正确网络连接
- 检查API费率限制和配额
- 验证
uvx命令在PATH中可用
许可证
此MCP服务器根据MIT许可证获得许可。有关完整详细信息,请参阅项目存储库中的LICENSE文件。
额外资源
Built with ❤️ by effy
