@frontmcp/sdk 0.5.0 → 0.6.0

package/src/tool/flows/call-tool.flow.d.ts

@@ -1,12 +1,20 @@
 import { FlowBase, FlowRunOptions, ToolContext, ToolEntry } from '../../common';
 import { z } from 'zod';
 import { AuthInfo } from '@modelcontextprotocol/sdk/server/auth/types.js';
+import { type ToolResponseContent } from '@frontmcp/ui/adapters';
 declare const inputSchema: z.ZodObject<{
     request: z.ZodObject<{
         method: z.ZodLiteral<"tools/call">;
         params: z.ZodObject<{
+            task: z.ZodOptional<z.ZodObject<{
+                ttl: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodNull]>>;
+                pollInterval: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$loose>>;
             _meta: z.ZodOptional<z.ZodObject<{
                 progressToken: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+                "io.modelcontextprotocol/related-task": z.ZodOptional<z.ZodObject<{
+                    taskId: z.ZodString;
+                }, z.core.$loose>>;
             }, z.core.$loose>>;
             name: z.ZodString;
             arguments: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -15,25 +23,61 @@ declare const inputSchema: z.ZodObject<{
     ctx: z.ZodAny;
 }, z.core.$strip>;
 declare const outputSchema: z.ZodObject<{
-    _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    _meta: z.ZodOptional<z.ZodObject<{
+        "io.modelcontextprotocol/related-task": z.ZodOptional<z.ZodObject<{
+            taskId: z.ZodString;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
     content: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
         type: z.ZodLiteral<"text">;
         text: z.ZodString;
+        annotations: z.ZodOptional<z.ZodObject<{
+            audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                user: "user";
+                assistant: "assistant";
+            }>>>;
+            priority: z.ZodOptional<z.ZodNumber>;
+            lastModified: z.ZodOptional<z.ZodISODateTime>;
+        }, z.core.$strip>>;
         _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"image">;
         data: z.ZodString;
         mimeType: z.ZodString;
+        annotations: z.ZodOptional<z.ZodObject<{
+            audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                user: "user";
+                assistant: "assistant";
+            }>>>;
+            priority: z.ZodOptional<z.ZodNumber>;
+            lastModified: z.ZodOptional<z.ZodISODateTime>;
+        }, z.core.$strip>>;
         _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, z.core.$strip>, z.ZodObject<{
         type: z.ZodLiteral<"audio">;
         data: z.ZodString;
         mimeType: z.ZodString;
+        annotations: z.ZodOptional<z.ZodObject<{
+            audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                user: "user";
+                assistant: "assistant";
+            }>>>;
+            priority: z.ZodOptional<z.ZodNumber>;
+            lastModified: z.ZodOptional<z.ZodISODateTime>;
+        }, z.core.$strip>>;
         _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, z.core.$strip>, z.ZodObject<{
         uri: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
         mimeType: z.ZodOptional<z.ZodString>;
+        annotations: z.ZodOptional<z.ZodObject<{
+            audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                user: "user";
+                assistant: "assistant";
+            }>>>;
+            priority: z.ZodOptional<z.ZodNumber>;
+            lastModified: z.ZodOptional<z.ZodISODateTime>;
+        }, z.core.$strip>>;
         _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
         icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
             src: z.ZodString;
@@ -56,6 +100,14 @@ declare const outputSchema: z.ZodObject<{
             _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
             blob: z.ZodString;
         }, z.core.$strip>]>;
+        annotations: z.ZodOptional<z.ZodObject<{
+            audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                user: "user";
+                assistant: "assistant";
+            }>>>;
+            priority: z.ZodOptional<z.ZodNumber>;
+            lastModified: z.ZodOptional<z.ZodISODateTime>;
+        }, z.core.$strip>>;
         _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, z.core.$strip>]>>>;
     structuredContent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -67,37 +119,65 @@ declare const stateSchema: z.ZodObject<{
         arguments: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
     }, z.core.$loose>;
     authInfo: z.ZodType<AuthInfo>;
-    tool: z.ZodCustom<ToolEntry<Readonly<{
-        [k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
-    }>, import("../../common").ToolOutputType, unknown, unknown>, ToolEntry<Readonly<{
-        [k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
-    }>, import("../../common").ToolOutputType, unknown, unknown>>;
-    toolContext: z.ZodCustom<ToolContext<Readonly<{
-        [k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
-    }>, import("../../common").ToolOutputType, unknown, unknown>, ToolContext<Readonly<{
-        [k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
-    }>, import("../../common").ToolOutputType, unknown, unknown>>;
+    tool: z.ZodCustom<ToolEntry<import("../../common").ToolInputType, import("../../common").ToolOutputType, unknown, unknown>, ToolEntry<import("../../common").ToolInputType, import("../../common").ToolOutputType, unknown, unknown>>;
+    toolContext: z.ZodCustom<ToolContext<import("../../common").ToolInputType, import("../../common").ToolOutputType, unknown, unknown>, ToolContext<import("../../common").ToolInputType, import("../../common").ToolOutputType, unknown, unknown>>;
     rawOutput: z.ZodOptional<z.ZodAny>;
     output: z.ZodObject<{
-        _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        _meta: z.ZodOptional<z.ZodObject<{
+            "io.modelcontextprotocol/related-task": z.ZodOptional<z.ZodObject<{
+                taskId: z.ZodString;
+            }, z.core.$loose>>;
+        }, z.core.$loose>>;
         content: z.ZodDefault<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
             type: z.ZodLiteral<"text">;
             text: z.ZodString;
+            annotations: z.ZodOptional<z.ZodObject<{
+                audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                    user: "user";
+                    assistant: "assistant";
+                }>>>;
+                priority: z.ZodOptional<z.ZodNumber>;
+                lastModified: z.ZodOptional<z.ZodISODateTime>;
+            }, z.core.$strip>>;
             _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"image">;
             data: z.ZodString;
             mimeType: z.ZodString;
+            annotations: z.ZodOptional<z.ZodObject<{
+                audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                    user: "user";
+                    assistant: "assistant";
+                }>>>;
+                priority: z.ZodOptional<z.ZodNumber>;
+                lastModified: z.ZodOptional<z.ZodISODateTime>;
+            }, z.core.$strip>>;
             _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         }, z.core.$strip>, z.ZodObject<{
             type: z.ZodLiteral<"audio">;
             data: z.ZodString;
             mimeType: z.ZodString;
+            annotations: z.ZodOptional<z.ZodObject<{
+                audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                    user: "user";
+                    assistant: "assistant";
+                }>>>;
+                priority: z.ZodOptional<z.ZodNumber>;
+                lastModified: z.ZodOptional<z.ZodISODateTime>;
+            }, z.core.$strip>>;
             _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         }, z.core.$strip>, z.ZodObject<{
             uri: z.ZodString;
             description: z.ZodOptional<z.ZodString>;
             mimeType: z.ZodOptional<z.ZodString>;
+            annotations: z.ZodOptional<z.ZodObject<{
+                audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                    user: "user";
+                    assistant: "assistant";
+                }>>>;
+                priority: z.ZodOptional<z.ZodNumber>;
+                lastModified: z.ZodOptional<z.ZodISODateTime>;
+            }, z.core.$strip>>;
             _meta: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
             icons: z.ZodOptional<z.ZodArray<z.ZodObject<{
                 src: z.ZodString;
@@ -120,17 +200,27 @@ declare const stateSchema: z.ZodObject<{
                 _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
                 blob: z.ZodString;
             }, z.core.$strip>]>;
+            annotations: z.ZodOptional<z.ZodObject<{
+                audience: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+                    user: "user";
+                    assistant: "assistant";
+                }>>>;
+                priority: z.ZodOptional<z.ZodNumber>;
+                lastModified: z.ZodOptional<z.ZodISODateTime>;
+            }, z.core.$strip>>;
             _meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         }, z.core.$strip>]>>>;
         structuredContent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
         isError: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$loose>;
     _toolOwnerId: z.ZodOptional<z.ZodString>;
+    uiResult: z.ZodType<ToolResponseContent | undefined>;
+    uiMeta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
 declare const plan: {
     readonly pre: ["parseInput", "findTool", "checkToolAuthorization", "createToolCallContext", "acquireQuota", "acquireSemaphore"];
     readonly execute: ["validateInput", "execute", "validateOutput"];
-    readonly finalize: ["releaseSemaphore", "releaseQuota", "finalize"];
+    readonly finalize: ["releaseSemaphore", "releaseQuota", "applyUI", "finalize"];
 };
 declare global {
     interface ExtendFlows {
@@ -160,6 +250,21 @@ export default class CallToolFlow extends FlowBase<typeof name> {
     validateOutput(): Promise<void>;
     releaseSemaphore(): Promise<void>;
     releaseQuota(): Promise<void>;
+    /**
+     * Apply UI rendering to the tool response.
+     * This stage handles all UI-related logic including platform detection,
+     * serving mode resolution, and content formatting.
+     */
+    applyUI(): Promise<void>;
+    /**
+     * Finalize the tool response.
+     * Validates output, applies UI result from applyUI stage, and sends the response.
+     *
+     * Note: This stage runs even when execute fails (as part of cleanup).
+     * If rawOutput is undefined, it means an error occurred during execution
+     * and the error will be propagated by the flow framework - we should not
+     * throw a new error here.
+     */
     finalize(): Promise<void>;
 }
 export {};