内容
NKS osTicket MCP适用于 [osTicket](https://osticket.com/) 的[模型上下文协议](https://modelcontextprotocol.io/)服务器。它允许 AI 代理(如 Claude 等)列出、搜索、读取、创建、更新、回复和删除工单,以及读取统计数据、管理父/子工单和下载附件。
它与配套的 [NKS osTicket API 插件](https://github.com/nks-hub/nks-osticket-plugin) 通信,该插件在 osTicket 中暴露一个单一的 JSON 端点。
## 工具列表
| 工具 | 用途 |
|---|---|
| `osticket_list_tickets` | 列出工单(按状态/部门过滤,分页) |
| `osticket_search_tickets` | 按主题全文搜索 |
| `osticket_get_ticket` | 一个包含完整消息线程的工单 |
| `osticket_get_stats` | 总数 / 打开 / 关闭 / 超期计数 |
| `osticket_list_statuses` | 所有工单状态 |
| `osticket_create_ticket` | 创建一个工单 |
| `osticket_update_ticket` | 更改状态 / 到期日期 / 主题,添加内部备注 |
| `osticket_reply_ticket` | 发布客户可见的回复(通过电子邮件发送) |
| `osticket_delete_ticket` | 删除一个工单(不可逆) |
| `osticket_link_subticket` | 在父工单下链接子工单 |
| `osticket_unlink_subticket` | 删除子工单的父链接 |
| `osticket_get_children` | 列出父工单的子工单 |
| `osticket_get_parent` | 获取子工单的父工单 |
| `osticket_download_attachment` | 下载附件(base64) |
## 要求
- Node.js ≥ 18
- 在您的 osTicket 实例上安装 NKS osTicket API 插件
- 一个 osTicket API 密钥(管理员 → 管理 → API 密钥),具有您的工具所需的权限,绑定到此服务器运行的源 IP
## 安装
```bash
npm install
npm run build
```
## 配置
通过环境变量设置(参见 `.env.example`):
| 变量 | 是否必需 | 默认值 | 描述 |
|---|---|---|---|
| `NKS_OSTICKET_URL` | 是 | – | API 入口的 URL,`…/api/nks-osticket.php` |
| `NKS_OSTICKET_API_KEY` | 是 | – | osTicket API 密钥 |
| `NKS_OSTICKET_TIMEOUT_MS` | 否 | `30000` | 请求超时 |
| `NKS_OSTICKET_REJECT_UNAUTHORIZED` | 否 | `true` | `false` 允许自签名 TLS |
## 与 Claude Code / Claude Desktop 一起使用
将以下内容添加到您的 MCP 服务器配置中:json
{
"mcpServers": {
"ost {
"command": "node",
"args": ["/absolute/path/to/nks-osticket-mcp/dist/index.js"],
env": {
"NKS_OSTICKET_URL":://support.example.com/api/nks-osticket.php",
"NKS_OSTICKET": "your-api-key"
}
}
}
}
```
## 许可证
MIT —阅 [LICENSE](LICENSE)。