gemini-cli - ✅(Solved) Fix [AgentProtocol] Formalize unified DisplayContent and DisplayName metadata via isolated toolDisplay prop [3 pull requests, 1 participants]

mbleigh · 2026-04-09T17:05:49Z

[gemini-cli] Currently, visual metadata like display names, descriptions, and result summaries is inconsistent across different AgentEvent types. To achieve a… Currently, visual metadata (like display names, descriptions, and result summaries) is inconsistent across different AgentEvent types. To achieve a true "dumb terminal" TUI, the protocol must provide structured, multi-representation content that the UI can render without knowing the specific context of the event. To ensure the existing `useGeminiStream` path remains 100% untouched, the new metadata must be isolated into a dedicated `toolDisplay` property that triggers an alternate rendering path in the UI components. # PR #25101: refactor(core): consolidate execute() arguments into ExecuteOptions - Repository: google-gemini/gemini-cli - Author: mbleigh - State: closed | merged: True - Link: https://github.com/google-gemini/gemini-cli/pull/25101 ## Description (problem / solution / changelog) ## Summary Consolidate `ToolInvocation.execute()` arguments into a single `ExecuteOptions` object. This simplifies the tool execution interface and makes it easier to extend with optional properties without changing positional argument signatures. ## Details - Updated `ExecuteOptions` in `packages/core/src/tools/tools.ts` to include `signal` and `updateOutput`. - Refactored `ToolInvocation.execute()` to accept only `ExecuteOptions`. - Migrated all tool implementations and agent invocation classes to the new signature. - Mass-replaced all call sites in `packages/core`, `packages/cli`, and `packages/sdk` using a script and manual cleanup. - This is a non-behavioral refactor that sets the stage for adding more display-related properties to tool execution. ## Related Issues Related to #25046 ## How to Validate `npm run preflight` to verify all tests, linting, and types pass across the monorepo. ## Pre-Merge Checklist - [ ] Updated relevant documentation and README (if needed) - [x] Added/updated tests (if needed) - [x] Noted breaking changes (if any) - [ ] Validated on required platforms/methods: - [x] MacOS - [x] npm run ## Changed files - `integration-tests/ripgrep-real.test.ts` (modified, +12/-4) - `packages/a2a-server/src/commands/memory.ts` (modified, +2/-2) - `packages/cli/src/acp/acpClient.ts` (modified, +4/-2) - `packages/cli/src/ui/hooks/atCommandProcessor.ts` (modified, +1/-1) - `packages/core/src/agents/agent-tool.ts` (modified, +7/-6) - `packages/core/src/agents/browser/analyzeScreenshot.test.ts` (modified, +19/-7) - `packages/core/src/agents/browser/analyzeScreenshot.ts` (modified, +2/-1) - `packages/core/src/agents/browser/browserAgentInvocation.test.ts` (modified, +53/-33) - `packages/core/src/agents/browser/browserAgentInvocation.ts` (modified, +3/-5) - `packages/core/src/agents/browser/mcpToolWrapper.test.ts` (modified, +22/-10) - `packages/core/src/agents/browser/mcpToolWrapper.ts` (modified, +2/-1) - `packages/core/src/agents/local-invocation.test.ts` (modified, +29/-17) - `packages/core/src/agents/local-invocation.ts` (modified, +3/-5) - `packages/core/src/agents/remote-invocation.test.ts` (modified, +44/-20) - `packages/core/src/agents/remote-invocation.ts` (modified, +3/-5) - `packages/core/src/core/coreToolHookTriggers.test.ts` (modified, +2/-6) - `packages/core/src/core/coreToolHookTriggers.ts` (modified, +6/-6) - `packages/core/src/test-utils/mock-tool.ts` (modified, +6/-11) - `packages/core/src/tools/activate-skill.test.ts` (modified, +6/-2) - `packages/core/src/tools/activate-skill.ts` (modified, +2/-1) - `packages/core/src/tools/ask-user.test.ts` (modified, +9/-3) - `packages/core/src/tools/ask-user.ts` (modified, +2/-1) - `packages/core/src/tools/complete-task.test.ts` (modified, +9/-3) - `packages/core/src/tools/complete-task.ts` (modified, +3/-1) - `packages/core/src/tools/edit.test.ts` (modified, +40/-18) - `packages/core/src/tools/edit.ts` (modified, +2/-1) - `packages/core/src/tools/enter-plan-mode.test.ts` (modified, +10/-4) - `packages/core/src/tools/enter-plan-mode.ts` (modified, +2/-1) - `packages/core/src/tools/exit-plan-mode.test.ts` (modified, +38/-16) - `packages/core/src/tools/exit-plan-mode.ts` (modified, +2/-1) - `packages/core/src/tools/get-internal-docs.test.ts` (modified, +4/-4) - `packages/core/src/tools/get-internal-docs.ts` (modified, +2/-1) - `packages/core/src/tools/glob.test.ts` (modified, +16/-16) - `packages/core/src/tools/glob.ts` (modified, +2/-1) - `packages/core/src/tools/grep.test.ts` (modified, +20/-20) - `packages/core/src/tools/grep.ts` (modified, +2/-1) - `packages/core/src/tools/line-endings.test.ts` (modified, +3/-3) - `packages/core/src/tools/ls.test.ts` (modified, +14/-14) - `packages/core/src/tools/ls.ts` (modified, +2/-1) - `packages/core/src/tools/mcp-tool.test.ts` (modified, +55/-42) - `packages/core/src/tools/mcp-tool.ts` (modified, +2/-1) - `packages/core/src/tools/memoryTool.test.ts` (modified, +6/-6) - `packages/core/src/tools/memoryTool.ts` (modified, +2/-1) - `packages/core/src/tools/read-

gemini-cli2026-04-09 17:05:49

ON THIS PAGE

Recommended Tools

×6

Utilities matched from this issue’s tags and category — try them while you read without losing context.

GitHub issue graph ai analysis

Paste a GitHub issue URL. We fetch that issue, discover linked issues from bodies/comments/timeline, collect linked pull requests, and produce a structured English report.

The report is written in English Markdown for sharing and archival.

GitHub issue URL

Helpful · Quick feedback

GitHub stats

google-gemini/gemini-cli#25046•Fetched 2026-04-10 03:44:58

View on GitHub

Comments

Participants

Timeline

Reactions

Author

mbleigh

Participants

mbleigh

Assignees

mbleigh

Timeline (top)

labeled ×2assigned ×1parent_issue_added ×1renamed ×1

Currently, visual metadata (like display names, descriptions, and result summaries) is inconsistent across different AgentEvent types. To achieve a true "dumb terminal" TUI, the protocol must provide structured, multi-representation content that the UI can render without knowing the specific context of the event.

To ensure the existing useGeminiStream path remains 100% untouched, the new metadata must be isolated into a dedicated toolDisplay property that triggers an alternate rendering path in the UI components.

Root Cause

Code Example

export type DisplayContent = {
    type: 'text';
    contentType?: 'text/markdown' | 'text/ansi-color' | 'text/plain';
    text: string;
  };

---

export type DisplayDiff = {
    type: 'diff';
    path?: string;
    diff?: string; // Unified diff string
    beforeText: string;
    afterText: string;
  };

---

toolDisplay?: {
    displayName: string;
    displaySummary?: DisplayContent;
    displayContent?: DisplayContent | DisplayDiff;
  };

RAW_BUFFERClick to expand / collapse

Context

Tasks

1. Define Discriminated Union Types (packages/core/src/agent/types.ts)

Define DisplayContent:

export type DisplayContent = {
  type: 'text';
  contentType?: 'text/markdown' | 'text/ansi-color' | 'text/plain';
  text: string;
};

Define DisplayDiff:

export type DisplayDiff = {
  type: 'diff';
  path?: string;
  diff?: string; // Unified diff string
  beforeText: string;
  afterText: string;
};

Add displayName: string, displaySummary: DisplayContent, and displayContent: DisplayContent | DisplayDiff to Agent Protocol events:
- ToolRequest
- ToolUpdate
- ToolResponse
- ElicitationRequest

2. Isolate UI Data Structure (packages/cli/src/ui/types.ts)

Add an optional toolDisplay field to IndividualToolCallDisplay:

toolDisplay?: {
  displayName: string;
  displaySummary?: DisplayContent;
  displayContent?: DisplayContent | DisplayDiff;
};

Constraint: Do not modify the existing resultDisplay, name, or description fields to avoid breaking legacy tool mapping (toolMapping.ts).

3. Bifurcated Rendering (packages/cli/src/ui/components/messages/ToolResultDisplay.tsx)

Implement a clean if (props.toolDisplay) branch.
New Path: Use structured metadata with priority: ANSI > Markdown > Plain. Respect explicit empty strings ('') for elision. Use DisplayDiff for rich diffs.
Legacy Path: Keep the original rendering logic exactly as it is for when toolDisplay is absent.
Update parent components (ToolMessage, ShellToolMessage, DenseToolMessage) to pass toolDisplay through.

4. Clean Ingestion (packages/cli/src/ui/hooks/useAgentStream.ts)

Map incoming Agent Protocol events into the new toolDisplay property.
Ensure useGeminiStream.ts and toolMapping.ts leave toolDisplay undefined.

Acceptance Criteria

useGeminiStream rendering is identical to the baseline (no regressions in legacy mode).
useAgentStream utilizes structured metadata for consistent, context-agnostic tool display.
DisplayDiff correctly leverages the existing DiffRenderer.
Explicit empty strings in the protocol result in elided UI output.

extent analysis

TL;DR

To achieve a consistent and context-agnostic tool display, implement the new toolDisplay property in the Agent Protocol events and update the UI components to render structured metadata.

Guidance

Define the DisplayContent and DisplayDiff types in packages/core/src/agent/types.ts to provide a structured format for metadata.
Update the UI components in packages/cli/src/ui/components/messages/ToolResultDisplay.tsx to render the new toolDisplay property, prioritizing ANSI, Markdown, and Plain text formats.
Ensure the useAgentStream hook in packages/cli/src/ui/hooks/useAgentStream.ts maps incoming Agent Protocol events into the new toolDisplay property without modifying the existing useGeminiStream path.
Verify that the new implementation meets the acceptance criteria, including identical rendering for useGeminiStream and correct utilization of structured metadata for useAgentStream.

Example

// packages/core/src/agent/types.ts
export type DisplayContent = {
  type: 'text';
  contentType?: 'text/markdown' | 'text/ansi-color' | 'text/plain';
  text: string;
};

export type DisplayDiff = {
  type: 'diff';
  path?: string;
  diff?: string; // Unified diff string
  beforeText: string;
  afterText: string;
};

Notes

The implementation should ensure that the existing useGeminiStream path remains unchanged to avoid regressions in legacy mode. The new toolDisplay property should be used to render structured metadata, and explicit empty strings in the protocol should result in elided UI output.

Recommendation

Apply the workaround by implementing the new toolDisplay property and updating the UI components to render structured metadata, as this will provide a consistent and context-agnostic tool display without modifying the existing useGeminiStream path.

Vote matrix · Quick signals

Works

Did the solution work? Tap to confirm.

Easy Fix

Was it a quick fix?

Time Saver

Did it save you time?

Blocking

Was it severely blocking?

Common Issue

Are others likely hitting this too?

Flaky / Intermittent

Is it intermittent?

Verified / Reproducible

Can you reproduce it reliably?

#conversation history #tool integration #LLM response #prompt template #agent execution

Still need to ship something?

×6

Another batch ranked right after the header list — different links, same matching logic.

gemini-cli - ✅(Solved) Fix [AgentProtocol] Formalize unified DisplayContent and DisplayName metadata via isolated toolDisplay prop [3 pull requests, 1 participants]

Recommended Tools

GitHub issue graph ai analysis

Root Cause

PR fix notes

PR #25101: refactor(core): consolidate execute() arguments into ExecuteOptions

Description (problem / solution / changelog)

Summary

Details

Related Issues

How to Validate

Pre-Merge Checklist

Changed files

PR #25134: feat(agent): implement tool-controlled display protocol (Steps 2-3)

Description (problem / solution / changelog)

Summary

Details

Related Issues

How to Validate

Pre-Merge Checklist

Changed files

PR #25186: refactor(cli): migrate core tools to native ToolDisplay property and fix UI rendering

Description (problem / solution / changelog)

Summary

Details

1. Core Tool Migrations

2. Event Pipeline & Type Updates

3. UI & Rendering Fixes

Related Issues

How to Validate

Pre-Merge Checklist

Changed files

Code Example

Context

Tasks

Acceptance Criteria

extent analysis

TL;DR

Guidance

Example

Notes

Recommendation

Still need to ship something?

RELATED_DISCOVERY

TRENDING