types.ts

mcp-server/src/tools/types.ts

1. import type { ZodRawShape } from "zod";
2. import type { PlinthConfig } from "../lib/config.js";
3. import type { RateLimiter } from "../lib/rateLimit.js";
5. /** MCP tool call result (text content only). */
6. export type ToolResult = {
7. content: Array<{ type: "text"; text: string }>;
8. isError?: boolean;
9. /** SDK result type carries an open index signature. */
10. [key: string]: unknown;
11. };
13. /**
14. * Per-invocation context. Config is injected rather than read from a global so
15. * handlers are portable across Node (stdio) and the Workers isolate, where each
16. * request/instance carries its own env-derived config.
17. */
18. export interface ToolContext {
19. config: PlinthConfig;
20. /** Shared rate limiter enforcing the 10/10s cap. Optional in tests. */
21. limiter?: RateLimiter;
22. }
24. /**
25. * A self-contained tool module. Every handler goes through plinthRequest(),
26. * which refuses to run until live requests are deliberately enabled, so a tool
27. * is always discoverable (ListTools) but cannot reach production by accident.
28. */
29. export interface ToolModule {
30. name: string;
31. config: {
32. title: string;
33. description: string;
34. inputSchema: ZodRawShape;
35. };
36. handler: (args: Record<string, unknown>, ctx: ToolContext) => Promise<ToolResult> | ToolResult;
37. }