Add 'displayInput' to bash tool schema #5321

Alb-O · 2025-12-10T11:47:33Z

This keeps tool metadata callbacks in sync with the in-memory toolcall state so display inputs can be passed through to completion. processor.ts now prefers a metadata-updated input when finishing a tool call, allowing modified displays of commands without changing the actual execution.

packages/opencode/src/session/prompt.ts: metadata callback updates the live toolcall entry (input/metadata/title/time/displayInput) before persisting, keeping the processor’s map aligned.
packages/opencode/src/session/processor.ts: completion/error handling uses match.state.displayInput (from metadata), so the UI shows the plugin-provided display args.

Use case: `nix develop` bash wrapper plugin

A plugin can wrap the bash tool and modify the final displayed command via displayInput. This is shown to the user through the UI and also modifies the agent history:

"tool.execute.before": async ({ tool }, state) => {
  if (tool.toLowerCase() !== "bash") return
  const command = state.args?.command
  if (!command) return

  // Show the unwrapped command in the UI
  state.args.displayInput = { ...state.args }

  // Run the wrapped command for execution
  state.args.command = `nix develop --quiet -c bash -c "${command.replace(/"/g, '\\"')}"`
}

Before:

$ nix develop --quiet -c bash -c "echo \"hello\""

After:

$ echo "hello"

This has many use cases other than just nix, e.g. sandbox-esque wrappers where the full wrapped command is not relevant enough to be constantly showing to the user or agent, and would otherwise clutter history.

rekram1-node · 2025-12-10T15:26:45Z

/review

packages/opencode/src/session/prompt.ts

rekram1-node · 2025-12-13T05:51:00Z

/review

packages/opencode/src/session/prompt.ts

Alb-O · 2025-12-13T07:09:43Z

idk if that was worth it
edit: yeah that broke it

rekram1-node · 2025-12-15T06:09:06Z

should be good to go tmr if i forget just @ me or dm

rekram1-node · 2025-12-17T20:41:05Z

/review

github-actions · 2025-12-17T20:41:57Z

lgtm

rekram1-node · 2025-12-19T06:16:10Z

/review

github-actions · 2025-12-19T06:17:31Z

packages/opencode/src/session/processor.ts


                case "tool-call": {
                  const match = toolcalls[value.toolCallId]
                  if (match) {


Suggestion: This line uses as any which the style guide recommends avoiding. Consider adding a proper type for the tool input that includes the optional displayInput property.

Suggested change

if (match) {

const { displayInput, ...execArgs } = value.input as Record<string, unknown> & { displayInput?: unknown }

github-actions · 2025-12-19T06:17:35Z

packages/opencode/src/session/message-v2.ts

-                toolCallId: part.callID,
-                input: part.state.input,
-                output: part.state.time.compacted ? "[Old tool result content cleared]" : part.state.output,
+                 toolCallId: part.callID,


Suggestion: There appears to be inconsistent whitespace here - the new lines have an extra leading space compared to the surrounding code. This looks like a formatting issue.

Suggested change

toolCallId: part.callID,

toolCallId: part.callID,

input: part.state.displayInput ?? part.state.input,

output: part.state.time.compacted ? "[Old tool result content cleared]" : part.state.output,

github-actions · 2025-12-19T06:17:37Z

packages/opencode/src/session/message-v2.ts

-                toolCallId: part.callID,
-                input: part.state.input,
-                errorText: part.state.error,
+                 toolCallId: part.callID,


Suggestion: Same inconsistent whitespace here - extra leading space on the new lines.

Suggested change

toolCallId: part.callID,

toolCallId: part.callID,

input: part.state.displayInput ?? part.state.input,

errorText: part.state.error,

github-actions · 2025-12-19T06:17:40Z

packages/opencode/src/session/prompt.ts

            },
          )
-          const result = await item.execute(args, {
+          const displayArgs = args.displayInput ?? args


Suggestion: Using delete on args mutates the original object passed in, which could lead to unexpected side effects. Consider destructuring instead to avoid mutation:

Suggested change

const displayArgs = args.displayInput ?? args

const { displayInput, ...execArgs } = args

const displayArgs = displayInput ?? args

const result = await item.execute(execArgs, {

github-actions · 2025-12-19T06:17:42Z

packages/opencode/src/session/prompt.ts

      if (!execute) continue

      // Wrap execute to add plugin hooks and format output
+      const schema = (item.inputSchema as any).jsonSchema


Suggestion: This uses as any which the style guide recommends avoiding. Consider using a more specific type or type guard.

Suggested change

const schema = (item.inputSchema as any).jsonSchema

const schema = (item.inputSchema as { jsonSchema?: { type?: string; properties?: Record<string, unknown> } }).jsonSchema

github-actions · 2025-12-19T06:17:45Z

packages/opencode/src/session/prompt.ts

Suggestion: Similar to above, using delete mutates the original args object. Since the MCP execute wrapper is invoked with caller-provided args, mutating them could cause issues. Consider using destructuring instead:

Suggested change

},

const { displayInput, ...execArgs } = args

const result = await execute(execArgs, opts)

And update the Plugin.trigger call above to use the original args if needed for the hook.

- Avoid mutating tool arguments by using destructuring instead of delete - Replace 'any' type assertions with more specific types for tool schemas and inputs - Fix inconsistent leading whitespace in MessageV2 tool part mapping

github-actions bot reviewed Dec 10, 2025

View reviewed changes

packages/opencode/src/session/prompt.ts Outdated Show resolved Hide resolved

github-actions bot reviewed Dec 10, 2025

View reviewed changes

packages/opencode/src/session/prompt.ts Outdated Show resolved Hide resolved

Alb-O force-pushed the dev branch from dcf8fdc to 887761a Compare December 10, 2025 20:17

github-actions bot reviewed Dec 13, 2025

View reviewed changes

packages/opencode/src/session/prompt.ts Outdated Show resolved Hide resolved

Alb-O force-pushed the dev branch from 088edc0 to efd0271 Compare December 13, 2025 07:14

Alb-O closed this Dec 18, 2025

Alb-O force-pushed the dev branch from 5cb94a1 to 5cf8e54 Compare December 18, 2025 17:51

Alb-O added 4 commits December 19, 2025 04:57

preserve display args from tool metadata

04fb2d4

__display args: use nullish coalescing and cleanup whitespace

6a33a3e

replace any with Record<string, unknown> for __display args

9a23ea4

refactor __display to displayInput tool schema

486e46e

Alb-O reopened this Dec 18, 2025

rekram1-node and others added 3 commits December 18, 2025 12:37

tweak: run generate script, and fix type assertion

ca9e139

fix

65b6678

Merge branch 'dev' into dev

9061bc0

github-actions bot reviewed Dec 19, 2025

View reviewed changes

refactor tool input handling

715f5ec

- Avoid mutating tool arguments by using destructuring instead of delete - Replace 'any' type assertions with more specific types for tool schemas and inputs - Fix inconsistent leading whitespace in MessageV2 tool part mapping

Alb-O changed the title ~~Preserve display args from tool metadata~~ Add 'displayInput' to bash tool schema Dec 20, 2025

github-actions bot mentioned this pull request Jan 5, 2026

fix: show tool input and output #6927

Open

	if (match) {
	const { displayInput, ...execArgs } = value.input as Record<string, unknown> & { displayInput?: unknown }

-          const displayArgs = args.displayInput ?? args
+          const { displayInput, ...execArgs } = args
+          const displayArgs = displayInput ?? args
+          const result = await item.execute(execArgs, {

	const schema = (item.inputSchema as any).jsonSchema
	const schema = (item.inputSchema as { jsonSchema?: { type?: string; properties?: Record<string, unknown> } }).jsonSchema

	},
	const { displayInput, ...execArgs } = args
	const result = await execute(execArgs, opts)

Add 'displayInput' to bash tool schema #5321

Are you sure you want to change the base?

Add 'displayInput' to bash tool schema #5321

Uh oh!

Conversation

Alb-O commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Use case: nix develop bash wrapper plugin

Uh oh!

rekram1-node commented Dec 10, 2025

Uh oh!

Uh oh!

Uh oh!

rekram1-node commented Dec 13, 2025

Uh oh!

Uh oh!

Alb-O commented Dec 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rekram1-node commented Dec 15, 2025

Uh oh!

rekram1-node commented Dec 17, 2025

Uh oh!

github-actions bot commented Dec 17, 2025

Uh oh!

rekram1-node commented Dec 19, 2025

Uh oh!

github-actions bot Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Alb-O commented Dec 10, 2025 •

edited

Loading

Use case: `nix develop` bash wrapper plugin

Alb-O commented Dec 13, 2025 •

edited

Loading