From c27ed8c90007a2bd7b556eaf7d105beb694b1839 Mon Sep 17 00:00:00 2001
From: catlog22 <catlog22@github.com>
Date: Wed, 1 Oct 2025 23:48:32 +0800
Subject: [PATCH] docs: Add comprehensive configuration sections
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

### Added Configuration Details
- **Gemini CLI Setup**: Essential settings.json configuration
- **.geminiignore**: Performance optimization guidelines
- **MCP Tools**: Complete setup guide with links and benefits
  - Exa MCP Server for external API patterns
  - Code Index MCP for advanced code search
  - Benefits and automatic fallback explanation

### Improvements
- Organized configuration into three clear sections: Essential, Recommended, Optional
- Added installation guide links for MCP servers
- Clarified that MCP tools are completely optional
- Consistent bilingual documentation structure

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
---
 README.md    | 43 ++++++++++++++++++++++++++++++++++++++++---
 README_CN.md | 43 ++++++++++++++++++++++++++++++++++++++++---
 2 files changed, 80 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 8087b42d..c356b4c8 100644
--- a/README.md
+++ b/README.md
@@ -116,9 +116,11 @@ After installation, run the following command to ensure CCW is working:
 
 ---
 
-## ⚙️ Essential Configuration
+## ⚙️ Configuration
 
-For optimal integration, configure your Gemini CLI settings by creating a `settings.json` file in `~/.gemini/`:
+### **Essential: Gemini CLI Setup**
+
+Configure Gemini CLI for optimal integration:
 
 ```json
 // ~/.gemini/settings.json
@@ -126,7 +128,42 @@ For optimal integration, configure your Gemini CLI settings by creating a `setti
   "contextFileName": "CLAUDE.md"
 }
 ```
-This ensures CCW's intelligent documentation system works seamlessly with the Gemini CLI.
+
+### **Recommended: .geminiignore**
+
+Optimize performance by excluding unnecessary files:
+
+```bash
+# .geminiignore (in project root)
+/dist/
+/build/
+/node_modules/
+/.next/
+*.tmp
+*.log
+/temp/
+
+# Include important docs
+!README.md
+!**/CLAUDE.md
+```
+
+### **Optional: MCP Tools** *(Enhanced Analysis)*
+
+MCP (Model Context Protocol) tools provide advanced codebase analysis. **Completely optional** - CCW works perfectly without them.
+
+#### Available MCP Servers
+
+| MCP Server | Purpose | Installation Guide |
+|------------|---------|-------------------|
+| **Exa MCP** | External API patterns & best practices | [Install Guide](https://github.com/exa-labs/exa-mcp-server) |
+| **Code Index MCP** | Advanced internal code search | [Install Guide](https://github.com/johnhuang316/code-index-mcp) |
+
+#### Benefits When Enabled
+- 📊 **Faster Analysis**: Direct codebase indexing vs manual searching
+- 🌐 **External Context**: Real-world API patterns and examples
+- 🔍 **Advanced Search**: Pattern matching and similarity detection
+- ⚡ **Automatic Fallback**: Uses traditional tools when MCP unavailable
 
 ---
 
diff --git a/README_CN.md b/README_CN.md
index 1ff50aae..43cde900 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -116,9 +116,11 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo
 
 ---
 
-## ⚙️ 核心配置
+## ⚙️ 配置
 
-为实现最佳集成，请在 `~/.gemini/` 中创建一个 `settings.json` 文件来配置您的 Gemini CLI 设置：
+### **必需: Gemini CLI 设置**
+
+配置 Gemini CLI 以实现最佳集成：
 
 ```json
 // ~/.gemini/settings.json
@@ -126,7 +128,42 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo
   "contextFileName": "CLAUDE.md"
 }
 ```
-这确保了 CCW 的智能文档系统能与 Gemini CLI 无缝协作。
+
+### **推荐: .geminiignore**
+
+通过排除不必要的文件来优化性能：
+
+```bash
+# .geminiignore (在项目根目录)
+/dist/
+/build/
+/node_modules/
+/.next/
+*.tmp
+*.log
+/temp/
+
+# 包含重要文档
+!README.md
+!**/CLAUDE.md
+```
+
+### **可选: MCP 工具** *(增强分析)*
+
+MCP (模型上下文协议) 工具提供高级代码库分析。**完全可选** - CCW 在没有它们的情况下也能完美工作。
+
+#### 可用的 MCP 服务器
+
+| MCP 服务器 | 用途 | 安装指南 |
+|------------|------|---------|
+| **Exa MCP** | 外部 API 模式和最佳实践 | [安装指南](https://github.com/exa-labs/exa-mcp-server) |
+| **Code Index MCP** | 高级内部代码搜索 | [安装指南](https://github.com/johnhuang316/code-index-mcp) |
+
+#### 启用后的好处
+- 📊 **更快分析**: 直接代码库索引 vs 手动搜索
+- 🌐 **外部上下文**: 真实世界的 API 模式和示例
+- 🔍 **高级搜索**: 模式匹配和相似性检测
+- ⚡ **自动回退**: MCP 不可用时使用传统工具
 
 ---