From 77f90d3460507f2882da3c84ea58b694a64d57e8 Mon Sep 17 00:00:00 2001
From: Mohamed Boudra <boudra.moha@gmail.com>
Date: Mon, 2 Nov 2026 05:09:28 +0100
Subject: [PATCH] docs(plugins): the hook result comment names metadata as the
 field that stays

---
 packages/plugin/src/server/lifecycle.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/plugin/src/server/lifecycle.ts b/packages/plugin/src/server/lifecycle.ts
index 89f1b62412..acc703ed12 100644
--- a/packages/plugin/src/server/lifecycle.ts
+++ b/packages/plugin/src/server/lifecycle.ts
@@ -132,7 +132,7 @@ export interface PluginHookRequests {
   "workspace.create.before": Omit<WorkspaceCreateRequest, "type" | "requestId">;
 }
 
-/** What a hook may return: a field it leaves out stays as it was. */
+/** What a hook may return. An omitted `metadata` stays as it was. */
 type PluginHookRequestResults = Omit<PluginHookRequests, "agent.open.before"> & {
   "agent.open.before": Omit<PluginSessionOpenRequest, "metadata"> & {
     metadata?: Readonly<Record<string, JsonValue>>;