fix: add file path for tool calls

[CodeYHJ]

Fixes #1234

Summary by CodeRabbit

• Improvements
  • Enhanced image handling in prompts by adding file path context alongside images. Each image now includes descriptive information about its source, improving content clarity and organization.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[chatgpt-codex-connector]

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

[coderabbitai]

📝 Walkthrough

Walkthrough

The addImageFiles function in the prompt builder now emits each image as a structured pair: a text block containing the file path followed by the original image URL block. This enhances contextual information without altering function signatures or downstream control flow.

Changes

Cohort / File(s)	Summary
Image Block Emission Enhancement src/main/presenter/threadPresenter/utils/promptBuilder.ts	Modified addImageFiles to emit text block with file path before each image URL block, providing explicit file path context in the prompt structure

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Images now whisper their names with pride,
File paths dancing right by their side,
Structure blooms where confusion once hid,
Each picture tells tales—nothing stayed bid!

Pre-merge checks and finishing touches

❌ Failed checks (4 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The PR title 'fix: add file path for tool calls' is unrelated to the linked issue #123, which requests improved code-block font rendering on Windows using a font-family fallback stack.	The title describes changes to file paths in tool calls, but issue #123 requires adding font-family support for code blocks on Windows. Ensure the title and changes align with the actual objective.
Linked Issues check	⚠️ Warning	The code changes in promptBuilder.ts add file path text before images, but issue #123 requires implementing a font-family fallback for better code-block rendering on Windows, which this change does not address.	Implement font-family settings for code blocks on Windows as specified in issue #123, such as adding 'JetBrains Mono', Consolas, or similar monospaced fonts to achieve improved rendering.
Out of Scope Changes check	⚠️ Warning	The changes to promptBuilder.ts adding file paths to image blocks are out of scope with respect to issue #123, which is about improving font rendering for code blocks on Windows.	Remove unrelated changes to promptBuilder.ts and focus the PR solely on implementing the font-family configuration for code blocks on Windows as described in issue #123.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

• 📝 Generate docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/main/presenter/threadPresenter/utils/promptBuilder.ts (1)

676-685: Add a clarifying comment to addContextMessages explaining why file paths aren't included for historical images.

The addImageFiles function adds file path text before images in new user messages for tool calls, while addContextMessages omits file paths for historical images. This design is intentional—file paths are needed only for new attachments that tools will operate on in the current request, not for images already discussed in context. Adding a brief comment to addContextMessages would prevent future developers from questioning this intentional inconsistency.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0b9bf2f and 453659e.

📒 Files selected for processing (1)

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

🧰 Additional context used

📓 Path-based instructions (13)

**/*.{ts,tsx,js,jsx,vue}

📄 CodeRabbit inference engine (CLAUDE.md)

Use English for logs and comments (Chinese text exists in legacy code, but new code should use English)

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

**/*.{ts,tsx}

📄 CodeRabbit inference engine (CLAUDE.md)

Enable and maintain strict TypeScript type checking for all files

**/*.{ts,tsx}: Always use try-catch to handle possible errors in TypeScript code
Provide meaningful error messages when catching errors
Log detailed error logs including error details, context, and stack traces
Distinguish and handle different error types (UserError, NetworkError, SystemError, BusinessError) with appropriate handlers in TypeScript
Use structured logging with logger.error(), logger.warn(), logger.info(), logger.debug() methods from logging utilities
Do not suppress errors (avoid empty catch blocks or silently ignoring errors)
Provide user-friendly error messages for user-facing errors in TypeScript components
Implement error retry mechanisms for transient failures in TypeScript
Avoid logging sensitive information (passwords, tokens, PII) in logs

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

src/main/presenter/**/*.ts

📄 CodeRabbit inference engine (CLAUDE.md)

Organize core business logic into dedicated Presenter classes, with one presenter per functional domain

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

src/main/**/*.ts

📄 CodeRabbit inference engine (CLAUDE.md)

Use EventBus from src/main/eventbus.ts for main-to-renderer communication, broadcasting events via mainWindow.webContents.send()

src/main/**/*.ts: Use EventBus pattern for inter-process communication within the main process to decouple modules
Use Electron's built-in APIs for file system and native dialogs instead of Node.js or custom implementations

src/main/**/*.ts: Electron main process code belongs in src/main/ with presenters in presenter/ (Window/Tab/Thread/Mcp/Config/LLMProvider) and eventbus.ts for app events
Use the Presenter pattern in the main process for UI coordination

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

**/*.ts

📄 CodeRabbit inference engine (CLAUDE.md)

Do not include AI co-authoring information (e.g., 'Co-Authored-By: Claude') in git commits

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

**/*.{js,ts,jsx,tsx,mjs,cjs}

📄 CodeRabbit inference engine (.cursor/rules/development-setup.mdc)

Write logs and comments in English

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

{src/main/presenter/**/*.ts,src/renderer/**/*.ts}

📄 CodeRabbit inference engine (.cursor/rules/electron-best-practices.mdc)

Implement proper inter-process communication (IPC) patterns using Electron's ipcRenderer and ipcMain APIs

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

src/**/*

📄 CodeRabbit inference engine (.cursor/rules/project-structure.mdc)

New features should be developed in the src directory

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

src/main/**/*.{js,ts}

📄 CodeRabbit inference engine (.cursor/rules/project-structure.mdc)

Main process code for Electron should be placed in src/main

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

src/**/*.{ts,tsx,vue,js,jsx}

📄 CodeRabbit inference engine (AGENTS.md)

Use Prettier with single quotes, no semicolons, and 100 character width

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

src/**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (AGENTS.md)

Use OxLint for linting JavaScript and TypeScript files

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

src/**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

src/**/*.{ts,tsx}: Use camelCase for variable and function names in TypeScript files
Use PascalCase for type and class names in TypeScript
Use SCREAMING_SNAKE_CASE for constant names

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

src/**/*.ts

📄 CodeRabbit inference engine (AGENTS.md)

Use EventBus for inter-process communication events

Files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

🧠 Learnings (2)

📚 Learning: 2025-11-25T05:27:39.200Z

Learnt from: CR
Repo: ThinkInAIXYZ/deepchat PR: 0
File: .cursor/rules/provider-guidelines.mdc:0-0
Timestamp: 2025-11-25T05:27:39.200Z
Learning: Applies to **/*Provider**/index.ts : Image events: `image_data` event must provide `data` (Base64 encoded) and `mimeType` fields; control single frame size and frequency to avoid blocking

Applied to files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

📚 Learning: 2025-11-25T05:26:11.312Z

Learnt from: CR
Repo: ThinkInAIXYZ/deepchat PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-25T05:26:11.312Z
Learning: Applies to src/main/presenter/configPresenter/**/*.ts : Store and retrieve custom prompts via `configPresenter.getCustomPrompts()` for config-based data source management

Applied to files:

• src/main/presenter/threadPresenter/utils/promptBuilder.ts

🔇 Additional comments (2)

src/main/presenter/threadPresenter/utils/promptBuilder.ts (2)

676-685: PR objectives don't match the code changes.

The PR references issue #123 which is about "improved code-block font rendering on Windows," but the actual code changes add file path text blocks to image messages for tool calls. This appears to be a documentation error - either the wrong issue number was referenced, or these changes belong in a different PR.

Please update the PR description to reference the correct issue or clarify the intent.

---

676-685: The code is correct as-is. The MessageFile type from src/shared/chat.d.ts defines path: string as a required property, not optional. TypeScript's type system enforces this at compile time, so using file.path without validation is safe and appropriate.

Likely an incorrect or invalid review comment.

[zerob13]

LGTM