getCustomers.ts

mcp-server/src/tools/getCustomers.ts

1. import { z } from "zod";
2. import type { ToolModule } from "./types.js";
3. import { plinthRequest, type PlinthParams } from "../lib/http.js";
4. import { toRequestDate } from "../lib/dates.js";
6. /**
7. * get_customers: customer records (Plinth method `customers.fetch`),
8. * filterable by exact email or a signup/last-login date range.
9. *
10. * There is no phone filter: the API silently drops a phone param (fails open)
11. * and returns the full customer list, so this tool must never accept one.
12. * Output is not yet gated on verified identity (lib/classification.ts).
13. *
14. * Wire notes: no wrapper key; records keyed `cust_{ordinal}`. Phone formats
15. * are inconsistent across records.
16. */
17. export const getCustomers: ToolModule = {
18. name: "get_customers",
19. config: {
20. title: "Get customers",
21. description:
22. "Look up customer records by exact email or signup/last-login date range. Read-only. No phone lookup (fail-open).",
23. inputSchema: {
24. email: z.email().optional().describe("Exact-match email."),
25. dateField: z.enum(["last_login", "signup"]).optional().describe("Default: signup."),
26. fromDate: z.string().optional().describe("ISO YYYY-MM-DD; converted to yyyymmdd on the wire."),
27. toDate: z.string().optional().describe("ISO YYYY-MM-DD; converted to yyyymmdd on the wire."),
28. offset: z.number().int().min(0).optional(),
29. limit: z.number().int().min(1).max(100).optional(),
30. },
31. },
32. async handler(args, ctx) {
33. const { email, dateField, fromDate, toDate, offset, limit } = args as {
34. email?: string;
35. dateField?: "last_login" | "signup";
36. fromDate?: string;
37. toDate?: string;
38. offset?: number;
39. limit?: number;
40. };
42. const params: PlinthParams = {
43. email,
44. date_field: dateField,
45. since: fromDate !== undefined ? toRequestDate(fromDate) : undefined,
46. until: toDate !== undefined ? toRequestDate(toDate) : undefined,
47. offset,
48. limit,
49. };
51. const body = await plinthRequest(ctx, "customers.fetch", params);
52. return { content: [{ type: "text", text: JSON.stringify(body, null, 2) }] };
53. },
54. };