@lincolnminto/zendesk-mcp-server 2.26.0 → 2.27.0
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.
- package/README.md +33 -0
- package/dist/index.js +1795 -55
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -43,6 +43,9 @@ then calls the right tools on your behalf.
|
|
|
43
43
|
conversation (opt-in: start the server with an
|
|
44
44
|
[export directory](docs/configuration.md#zendesk_export_dir)).
|
|
45
45
|
|
|
46
|
+
For resumable bulk account snapshots, see [the `export-data` subcommand](docs/configuration.md#bulk-data-export-export-data);
|
|
47
|
+
to record how Zendesk behaves on that data, see [`record-goldens`](docs/configuration.md#golden-observations-record-goldens).
|
|
48
|
+
|
|
46
49
|
## Why this server
|
|
47
50
|
|
|
48
51
|
Most Zendesk integrations run on a shared admin API key, which hands every user
|
|
@@ -262,6 +265,36 @@ attachment-vision caps) lives in
|
|
|
262
265
|
**[docs/configuration.md](docs/configuration.md)**. Every variable has its own
|
|
263
266
|
anchor, so you can deep-link a specific setting.
|
|
264
267
|
|
|
268
|
+
## Snapshot e goldens (pt-BR)
|
|
269
|
+
|
|
270
|
+
Dois subcomandos de linha de comando, só com GET no Zendesk e o token de escopo
|
|
271
|
+
`read`, para quem vai substituir o Zendesk e precisa compará-lo com o sistema novo:
|
|
272
|
+
|
|
273
|
+
- `zendesk-mcp-server export-data <subdominio> --export-dir <pasta-absoluta>`
|
|
274
|
+
grava um snapshot completo da conta (tickets, usuários, organizações, grupos,
|
|
275
|
+
vínculos, eventos com comentários, metadados de anexos, métricas, avaliações,
|
|
276
|
+
registros de objetos personalizados, conversas paralelas e configuração) em
|
|
277
|
+
NDJSON, numa pasta datada com `manifest.json`. Respeita os
|
|
278
|
+
limites de requisição e retoma de onde parou com `--resume <pasta>`; `--since`
|
|
279
|
+
traz o delta dos streams incrementais. Tickets e eventos de ticket enviam
|
|
280
|
+
`support_type_scope=all` em todas as páginas, incluindo tickets de agentes de IA.
|
|
281
|
+
O stream `custom_object_records` grava `custom_object_records.ndjson` com
|
|
282
|
+
`custom_object_key` e exporta todos os registros a cada execução, mesmo com
|
|
283
|
+
`--since`. O stream `side_conversation_events` grava eventos incrementais em
|
|
284
|
+
`side_conversation_events.ndjson` e as conversas referenciadas em
|
|
285
|
+
`side_conversations.ndjson`, com `ticket_id` e sem duplicá-las no snapshot.
|
|
286
|
+
Ambos ficam ligados por padrão e podem ser selecionados com `--only <stream>`;
|
|
287
|
+
contas sem acesso ao add-on de conversas paralelas registram o stream como
|
|
288
|
+
indisponível (`skipped`) no manifest e seguem com o export.
|
|
289
|
+
- `zendesk-mcp-server record-goldens <subdominio> --export-dir <pasta-absoluta> --data-snapshot <pasta-do-export>`
|
|
290
|
+
grava o comportamento do Zendesk sobre esse snapshot: visualizações
|
|
291
|
+
compartilhadas ativas (contagem, ids em ordem, linhas), prévias de macros,
|
|
292
|
+
estado de SLA e audits de uma amostra e buscas representativas.
|
|
293
|
+
|
|
294
|
+
Os dois existem também como ferramentas MCP (`export_data`, `record_goldens`)
|
|
295
|
+
quando o servidor sobe com `--export-dir`. Flags, arquivos gerados e retomada:
|
|
296
|
+
[docs/configuration.md](docs/configuration.md#bulk-data-export-export-data).
|
|
297
|
+
|
|
265
298
|
## Troubleshooting
|
|
266
299
|
|
|
267
300
|
Browser not opening during OAuth login, the callback port already in use, having
|