zd-agent-cli 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: zendesk
|
|
3
|
+
description: "Use this skill when the user asks to triage Zendesk queues, inspect tickets, or draft support replies in Zendesk Agent Workspace via the `zagent` CLI."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Zendesk
|
|
7
|
+
|
|
8
|
+
Use this skill to run Zendesk triage workflows safely and consistently with the local `zagent` CLI.
|
|
9
|
+
|
|
10
|
+
## When To Use
|
|
11
|
+
|
|
12
|
+
- The user asks to triage a Zendesk queue.
|
|
13
|
+
- The user asks to process open Zendesk tickets sequentially.
|
|
14
|
+
- The user asks to read ticket details or draft reply content from Zendesk data.
|
|
15
|
+
|
|
16
|
+
## When Not To Use
|
|
17
|
+
|
|
18
|
+
- The user asks for non-Zendesk support strategy with no need to read live tickets.
|
|
19
|
+
- The user asks for bulk parallel processing across multiple queues in one pass.
|
|
20
|
+
- Required local runtime checks fail (CLI, auth, config, or CDP).
|
|
21
|
+
|
|
22
|
+
## CLI Setup Required
|
|
23
|
+
|
|
24
|
+
- Interactive macOS session with Chrome available.
|
|
25
|
+
- CDP reachable at `http://127.0.0.1:9223`.
|
|
26
|
+
- Chrome profile already signed into Zendesk Agent Workspace.
|
|
27
|
+
- `zagent` installed on PATH (for example: `npm install -g zd-agent-cli`).
|
|
28
|
+
- `zendesk.config.json` present at repo root with: `domain`, `startPath`, `defaultQueue`, `queues`.
|
|
29
|
+
|
|
30
|
+
Run these checks before queue work:
|
|
31
|
+
|
|
32
|
+
1. `zagent --help`
|
|
33
|
+
2. `zagent --json doctor`
|
|
34
|
+
3. `zagent --json auth check`
|
|
35
|
+
4. `zagent --json queue list`
|
|
36
|
+
|
|
37
|
+
If any check fails, stop and report exactly what is missing.
|
|
38
|
+
|
|
39
|
+
## Inputs To Confirm
|
|
40
|
+
|
|
41
|
+
- Target queue alias (use user-provided alias; otherwise use configured default).
|
|
42
|
+
- Ticket count limit for this run.
|
|
43
|
+
- Reply mode:
|
|
44
|
+
- `draft-only` (recommended default)
|
|
45
|
+
- `apply` only if user explicitly asks to post/update
|
|
46
|
+
|
|
47
|
+
## Standard Workflow
|
|
48
|
+
|
|
49
|
+
1. Preflight:
|
|
50
|
+
- `zagent --json queue list`
|
|
51
|
+
- Validate requested alias exists.
|
|
52
|
+
2. Read queue:
|
|
53
|
+
- `zagent --json queue read "<queue-alias>" --count <n>`
|
|
54
|
+
3. Process sequentially, one ticket at a time:
|
|
55
|
+
- `zagent --json ticket read "<ticket-id>" --comments <n>`
|
|
56
|
+
- Gather context and classify action needed.
|
|
57
|
+
- Draft a concise response aligned with ticket context.
|
|
58
|
+
4. Use search only when required for cross-ticket context:
|
|
59
|
+
- `zagent --json search tickets "<query>" --count <n>`
|
|
60
|
+
5. Return a run summary and explicit next actions.
|
|
61
|
+
|
|
62
|
+
## Output Format
|
|
63
|
+
|
|
64
|
+
For each run, provide:
|
|
65
|
+
|
|
66
|
+
1. Queue used and number of tickets reviewed.
|
|
67
|
+
2. Per-ticket summary:
|
|
68
|
+
- ticket id
|
|
69
|
+
- issue summary
|
|
70
|
+
- recommended action
|
|
71
|
+
- draft reply (if requested)
|
|
72
|
+
3. Risks/blockers needing human decision.
|
|
73
|
+
4. Final checklist of what was done vs not done.
|
|
74
|
+
|
|
75
|
+
## Guardrails
|
|
76
|
+
|
|
77
|
+
- Process tickets sequentially only (no parallel execution).
|
|
78
|
+
- Do not claim actions were posted unless the command actually executed.
|
|
79
|
+
- Default to `draft-only` unless the user explicitly requests applying changes.
|
|
80
|
+
- Do not invent missing ticket data; call out uncertainty.
|
|
81
|
+
- If queue alias is invalid, stop and ask user to choose from `queue list`.
|
|
82
|
+
|
|
83
|
+
## Troubleshooting
|
|
84
|
+
|
|
85
|
+
- Missing config:
|
|
86
|
+
- Symptom: queue list/read fails early with missing/invalid config error.
|
|
87
|
+
- Action: create/fix `zendesk.config.json` and rerun `queue list`.
|
|
88
|
+
- Invalid queue alias:
|
|
89
|
+
- Symptom: requested queue not found.
|
|
90
|
+
- Action: run `queue list` and use one of the returned aliases.
|
|
91
|
+
- CDP unavailable:
|
|
92
|
+
- Symptom: cannot connect to `http://127.0.0.1:9223`.
|
|
93
|
+
- Action: verify Chrome CDP session is running, then rerun `zagent --json doctor`.
|
|
94
|
+
- Auth/session issues:
|
|
95
|
+
- Symptom: Zendesk pages redirect to login or return unauthorized API data.
|
|
96
|
+
- Action: run `zagent auth login --timeout 300`, complete login in Chrome, then rerun `zagent --json auth check`.
|
|
97
|
+
- Transient navigation/network issues:
|
|
98
|
+
- Symptom: intermittent `page.goto` failures or aborted navigation.
|
|
99
|
+
- Action: retry once; if persistent, validate domain/startPath/queue path in config.
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zd-agent-cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5",
|
|
4
4
|
"description": "AI Agent ready Zendesk access through your existing browser session. No API keys required.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -11,7 +11,8 @@
|
|
|
11
11
|
"dist",
|
|
12
12
|
"README.md",
|
|
13
13
|
"LICENSE",
|
|
14
|
-
"zendesk.config.example.json"
|
|
14
|
+
"zendesk.config.example.json",
|
|
15
|
+
".agents"
|
|
15
16
|
],
|
|
16
17
|
"engines": {
|
|
17
18
|
"node": ">=20"
|