chore: update readme and enable shell tool #1180
Conversation
|
@codex review |
WalkthroughThis PR rebrands the platform from a chat-centric to agent-centric model across three language versions of the README, emphasizing ACP (Agent Client Protocol) integration, while simplifying PowerpackServer by unconditionally exposing the run_shell_command tool without conditional gating. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
|
Codex Review: Didn't find any major issues. Keep it up! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.jp.md(6 hunks)README.md(6 hunks)README.zh.md(6 hunks)src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (14)
**/*.{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/mcpPresenter/inMemoryServers/powerpackServer.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/mcpPresenter/inMemoryServers/powerpackServer.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/mcpPresenter/inMemoryServers/powerpackServer.ts
src/main/**/*.ts
📄 CodeRabbit inference engine (CLAUDE.md)
Use EventBus from
src/main/eventbus.tsfor main-to-renderer communication, broadcasting events viamainWindow.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 insrc/main/with presenters inpresenter/(Window/Tab/Thread/Mcp/Config/LLMProvider) andeventbus.tsfor app events
Use the Presenter pattern in the main process for UI coordination
Files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.ts
src/main/presenter/mcpPresenter/**/*.ts
📄 CodeRabbit inference engine (CLAUDE.md)
Register new MCP tools in
mcpPresenter/index.tsafter implementing them ininMemoryServers/
Files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.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/mcpPresenter/inMemoryServers/powerpackServer.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/mcpPresenter/inMemoryServers/powerpackServer.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/mcpPresenter/inMemoryServers/powerpackServer.ts
src/**/*
📄 CodeRabbit inference engine (.cursor/rules/project-structure.mdc)
New features should be developed in the
srcdirectory
Files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.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/mcpPresenter/inMemoryServers/powerpackServer.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/mcpPresenter/inMemoryServers/powerpackServer.ts
src/**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (AGENTS.md)
Use OxLint for linting JavaScript and TypeScript files
Files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.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/mcpPresenter/inMemoryServers/powerpackServer.ts
src/**/*.ts
📄 CodeRabbit inference engine (AGENTS.md)
Use EventBus for inter-process communication events
Files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.ts
🧠 Learnings (4)
📚 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/mcpPresenter/**/*.ts : Register new MCP tools in `mcpPresenter/index.ts` after implementing them in `inMemoryServers/`
Applied to files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.ts
📚 Learning: 2025-11-25T05:27:12.209Z
Learnt from: CR
Repo: ThinkInAIXYZ/deepchat PR: 0
File: .cursor/rules/llm-agent-loop.mdc:0-0
Timestamp: 2025-11-25T05:27:12.209Z
Learning: Applies to src/main/presenter/llmProviderPresenter/providers/*.ts : In Provider implementations, handle native tool support by converting MCP tools to Provider format using `convertToProviderTools` and including them in the API request; for Providers without native function call support, prepare messages using `prepareFunctionCallPrompt` before making the API call
Applied to files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.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/llmProviderPresenter/providers/*.ts : Convert MCP tools to provider-specific formats and normalize streaming responses to standard events in each provider implementation
Applied to files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.ts
📚 Learning: 2025-11-25T05:27:12.209Z
Learnt from: CR
Repo: ThinkInAIXYZ/deepchat PR: 0
File: .cursor/rules/llm-agent-loop.mdc:0-0
Timestamp: 2025-11-25T05:27:12.209Z
Learning: Implement separation of concerns where `src/main/presenter/llmProviderPresenter/index.ts` manages the Agent loop and conversation history, while Provider files handle LLM API interactions, Provider-specific request/response formatting, tool definition conversion, and native vs non-native tool call mechanisms
Applied to files:
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.ts
🪛 markdownlint-cli2 (0.18.1)
README.md
131-131: Bare URL used
(MD034, no-bare-urls)
README.jp.md
131-131: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build-check (x64)
🔇 Additional comments (5)
src/main/presenter/mcpPresenter/inMemoryServers/powerpackServer.ts (1)
451-460: LGTM! Shell tool now unconditionally exposed.The
run_shell_commandtool is now always available in the tools list, which aligns with the PR objective to enable the shell tool. The existing security measures remain in place:
checkShellCommandSafetyblocks dangerous patterns (sudo, rm -rf, shutdown, etc.)resolveShellCwdsandboxes execution within temp directories- Command timeout and maxBuffer limits prevent resource exhaustion
This change supports the ACP agent integration narrative described in the README updates.
README.zh.md (2)
5-7: Clear rebranding to agent platform.The title and description effectively communicate the shift from a chat-centric platform to an agent-centric platform that integrates models, tools, and agents through MCP and ACP protocols.
121-132: Well-structured ACP integration documentation.The new ACP Integration section provides clear quick-start steps and links to the ACP ecosystem. The documentation is actionable and helps users understand how to enable and use ACP agents within DeepChat.
README.md (1)
5-7: Effective rebranding to agent platform.The updated title and description clearly position DeepChat as an agent platform that unifies models, tools, and agents through MCP and ACP integration, moving beyond the previous chat-centric messaging.
README.jp.md (1)
5-7: Consistent agent platform positioning.The Japanese README updates mirror the English and Chinese versions, clearly communicating DeepChat's evolution to an agent platform with MCP tool calling and ACP agent integration.
Summary by CodeRabbit
Release Notes
Documentation
Features
✏️ Tip: You can customize this high-level summary in your review settings.