summaryrefslogtreecommitdiff
path: root/packages/cli/src/tools/ToolResult.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/cli/src/tools/ToolResult.ts')
-rw-r--r--packages/cli/src/tools/ToolResult.ts22
1 files changed, 22 insertions, 0 deletions
diff --git a/packages/cli/src/tools/ToolResult.ts b/packages/cli/src/tools/ToolResult.ts
new file mode 100644
index 00000000..674e2fcb
--- /dev/null
+++ b/packages/cli/src/tools/ToolResult.ts
@@ -0,0 +1,22 @@
+/**
+ * Standard tool result interface that all tools should implement
+ */
+export interface ToolResult {
+ /**
+ * Content meant to be included in LLM history.
+ * This should represent the factual outcome of the tool execution.
+ */
+ llmContent: string;
+
+ /**
+ * Markdown string for user display.
+ * This provides a user-friendly summary or visualization of the result.
+ */
+ returnDisplay: ToolResultDisplay;
+}
+
+export type ToolResultDisplay = string | FileDiff;
+
+export interface FileDiff {
+ fileDiff: string
+}