getStatusCatalog.ts

mcp-server/src/tools/getStatusCatalog.ts

1. import type { ToolModule } from "./types.js";
2. import { plinthRequest } from "../lib/http.js";
4. /**
5. * get_status_catalog: the complete status-definition catalog (Plinth method
6. * `statuses.list`). A lookup table, NOT a per-order query; all filter params,
7. * order_ref included, are ignored.
8. *
9. * Wire notes:
10. * - `status_code` is the STABLE identifier and is what appears on orders. The
11. * `row_N` ordinal keys are NOT stable (the catalog gained an entry and
12. * reshuffled between two pulls), so never hardcode them; re-pull on a
13. * schedule and map by status_code.
14. */
15. export const getStatusCatalog: ToolModule = {
16. name: "get_status_catalog",
17. config: {
18. title: "Get order-status catalog",
19. description:
20. "Return the full status-definition catalog mapping status_code to definitions. Lookup table, read-only.",
21. inputSchema: {},
22. },
23. async handler(_args, ctx) {
24. const body = await plinthRequest(ctx, "statuses.list");
25. return { content: [{ type: "text", text: JSON.stringify(body, null, 2) }] };
26. },
27. };