@fruggr/zendesk-mcp-server 2.9.0 → 2.10.0

package/dist/index.js

@@ -909,6 +909,24 @@ const formatTicketField = (field) => {
 		...options.map((o) => `  - ${o.name} → ${o.value}`)
 	].filter(Boolean).join("\n");
 };
+const formatFieldValue = (value) => Array.isArray(value) ? value.map(formatFieldValue).join(", ") : formatConditionValue(value);
+const MACRO_VALUE_PREVIEW = 120;
+const formatMacroActionValue = (value) => {
+	const oneLine = formatFieldValue(value).replace(/\s+/g, " ").trim();
+	return oneLine.length > MACRO_VALUE_PREVIEW ? `${oneLine.slice(0, MACRO_VALUE_PREVIEW)}…` : oneLine;
+};
+const formatMacroAction = (action) => `  - ${action.field} → ${formatMacroActionValue(action.value)}`;
+const formatMacro = (macro) => {
+	const scope = macro.restriction?.type ? "restricted" : "shared";
+	const actions = macro.actions ?? [];
+	return [
+		`## ${macro.title} (id ${macro.id})`,
+		`- **${macro.active ? "active" : "inactive"}** | **Scope**: ${scope}`,
+		macro.description ? `- **Description**: ${macro.description}` : "",
+		actions.length > 0 ? "- **Actions**:" : "- **Actions**: none",
+		...actions.map(formatMacroAction)
+	].filter(Boolean).join("\n");
+};
 const minutesUntil = (iso) => {
 	const t = Date.parse(iso);
 	return Number.isNaN(t) ? null : Math.round((t - Date.now()) / 6e4);
@@ -1010,6 +1028,11 @@ const extractPaginationMeta = (response, itemCount) => ({
 	after_cursor: response.meta?.after_cursor ?? null,
 	count: response.count ?? itemCount
 });
+const extractOffsetPaginationMeta = (response, itemCount, perPage, page) => response.count != null ? extractSearchPaginationMeta(response, perPage, page) : {
+	count: itemCount,
+	has_more: false,
+	after_cursor: null
+};
 const extractSearchPaginationMeta = (response, perPage, page) => {
 	const count = response.count ?? 0;
 	const has_more = count > page * perPage;
@@ -2091,6 +2114,71 @@ const fetchTicketSla = async (subdomain, token, ticket) => {
 		return;
 	}
 };
+const DIFF_SKIP_KEYS = /* @__PURE__ */ new Set([
+	"comment",
+	"fields",
+	"custom_fields",
+	"id",
+	"url",
+	"created_at",
+	"updated_at",
+	"generated_timestamp",
+	"encoded_id"
+]);
+const valuesEqual = (a, b) => a === b || JSON.stringify(a) === JSON.stringify(b);
+const shownValue = (v) => {
+	const s = formatFieldValue(v);
+	return s === "" ? "(empty)" : s;
+};
+const diffLine = (label, before, after) => {
+	const b = shownValue(before);
+	const a = shownValue(after);
+	return b === a ? null : `- **${label}**: ${b} → ${a}`;
+};
+const formatTagDiff = (before, after) => {
+	const b = new Set(Array.isArray(before) ? before.map(String) : []);
+	const a = new Set(Array.isArray(after) ? after.map(String) : []);
+	const added = [...a].filter((t) => !b.has(t)).map((t) => `+${t}`);
+	const removed = [...b].filter((t) => !a.has(t)).map((t) => `-${t}`);
+	return added.length + removed.length === 0 ? null : `- **tags**: ${[...added, ...removed].join(", ")}`;
+};
+const formatMacroPreviewDiff = (ticketId, macroId, before, result) => {
+	const after = result?.ticket ?? {};
+	const beforeObj = before ?? {};
+	const comment = after.comment ?? result?.comment;
+	const changes = [];
+	for (const [key, afterVal] of Object.entries(after)) {
+		if (DIFF_SKIP_KEYS.has(key)) continue;
+		const beforeVal = beforeObj[key];
+		if (valuesEqual(beforeVal, afterVal)) continue;
+		if (key === "tags") {
+			const tagLine = formatTagDiff(beforeVal, afterVal);
+			if (tagLine) changes.push(tagLine);
+			continue;
+		}
+		if (afterVal !== null && typeof afterVal === "object" && !Array.isArray(afterVal)) continue;
+		const line = diffLine(key, beforeVal, afterVal);
+		if (line) changes.push(line);
+	}
+	const afterFields = [after.fields ?? after.custom_fields ?? []].flat();
+	const beforeById = new Map((before?.custom_fields ?? []).map((f) => [f.id, f.value]));
+	for (const f of afterFields) {
+		const line = diffLine(`custom field ${f.id}`, beforeById.get(f.id), f.value);
+		if (line) changes.push(line);
+	}
+	const lines = [
+		`# Macro #${macroId} preview on ticket #${ticketId} (diff — nothing saved yet)`,
+		"",
+		"## Field changes",
+		...changes.length > 0 ? changes : ["- none"]
+	];
+	if (comment?.body) {
+		const visibility = comment.public === false ? "internal note" : "public comment";
+		lines.push("", `## Reply (${visibility})`, "", comment.body);
+	} else lines.push("", "## Reply", "- none");
+	lines.push("", "## To apply these changes", "Nothing has been committed. Persist the field changes with `update_ticket` (or `manage_tags` for incremental tag edits), and post the reply with `add_public_comment` (public) or `add_private_note` (internal). Edit the reply text first if needed.");
+	return lines.join("\n");
+};
 const createTicketTools = (ctx) => {
 	const { subdomain, getToken } = ctx;
 	const attachmentSchema = z.object({
@@ -2491,11 +2579,7 @@ const createTicketTools = (ctx) => {
 				const policies = response.sla_policies ?? [];
 				return { content: [{
 					type: "text",
-					text: formatList(policies, formatSlaPolicy, response.count != null ? extractSearchPaginationMeta(response, per_page, page) : {
-						count: policies.length,
-						has_more: false,
-						after_cursor: null
-					})
+					text: formatList(policies, formatSlaPolicy, extractOffsetPaginationMeta(response, policies.length, per_page, page))
 				}] };
 			}
 		},
@@ -2525,6 +2609,59 @@ const createTicketTools = (ctx) => {
 					text: formatList(fields, formatTicketField, extractPaginationMeta(response, fields.length))
 				}] };
 			}
+		},
+		{
+			name: "list_macros",
+			namespace: "tickets",
+			readOnly: true,
+			title: "List Zendesk Macros",
+			description: "List the active macros available to the authenticated user. A macro bundles a canned reply and/or a set of field changes (status, priority, assignee, group, tags, custom fields) an agent applies to a ticket in one gesture; this returns each macro id, title, description, availability scope, and its ordered list of actions, offset-paginated. Results are scoped by per-user OAuth to what the current user can see, so no shared admin key is needed. Pass a macro id from here to preview_macro_diff to preview its effect on a specific ticket.",
+			inputSchema: z.object({
+				per_page: z.number().int().min(1).max(100).default(100).describe(PER_PAGE_DESC),
+				page: z.number().int().min(1).default(1).describe(PAGE_DESC)
+			}),
+			annotations: {
+				readOnlyHint: true,
+				destructiveHint: false,
+				idempotentHint: true,
+				openWorldHint: true
+			},
+			handler: async (params) => {
+				const { per_page, page } = params;
+				const token = await getToken();
+				const response = await zendeskGet(subdomain, token, "/macros/active", buildOffsetParams(per_page, page));
+				const macros = response.macros ?? [];
+				return { content: [{
+					type: "text",
+					text: formatList(macros, formatMacro, extractOffsetPaginationMeta(response, macros.length, per_page, page))
+				}] };
+			}
+		},
+		{
+			name: "preview_macro_diff",
+			namespace: "tickets",
+			readOnly: false,
+			title: "Preview a Macro Diff on a Ticket",
+			description: "Preview the exact changes a macro would make to a specific ticket, as a before → after diff, WITHOUT saving anything. Orchestrates two reads — the ticket's current state and Zendesk's macro-apply preview (which returns the whole resulting ticket) — and returns only the fields the macro actually changes (status, priority, assignee, group, tags, custom fields) plus the canned reply with its public/internal flag; unchanged and identity fields are omitted. Nothing is committed: to apply it, follow up with update_ticket for the field changes and add_public_comment or add_private_note for the reply. This deliberate two-step keeps the mutation explicit and reviewable rather than hidden. Find macro ids via list_macros and the ticket id via search_tickets or list_tickets.",
+			inputSchema: z.object({
+				ticket_id: z.number().int().describe("Ticket ID — the numeric id of the ticket to preview the macro against. Obtain it from search_tickets or list_tickets."),
+				macro_id: z.number().int().describe("Macro ID — the numeric id of the macro to preview. Obtain it from list_macros.")
+			}),
+			annotations: {
+				readOnlyHint: false,
+				destructiveHint: false,
+				idempotentHint: true,
+				openWorldHint: true
+			},
+			handler: async (params) => {
+				const { ticket_id, macro_id } = params;
+				const token = await getToken();
+				const [{ ticket: before }, { result }] = await Promise.all([zendeskGet(subdomain, token, `/tickets/${ticket_id}`), zendeskGet(subdomain, token, `/tickets/${ticket_id}/macros/${macro_id}/apply`)]);
+				return { content: [{
+					type: "text",
+					text: truncateIfNeeded(formatMacroPreviewDiff(ticket_id, macro_id, before, result))
+				}] };
+			}
 		}
 	];
 };