mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
docs: Add comprehensive MCP Tools configuration sections to both READMEs
## Documentation Enhancements - **MCP Configuration Sections**: Added dedicated "MCP Tools Configuration" sections in both English and Chinese READMEs - **Installation Guidance**: Clear step-by-step MCP server installation guides with direct repository links - **Configuration Resources**: Comprehensive table with installation guides and purposes for each MCP server - **Benefits Overview**: Detailed explanation of enhanced capabilities when MCP tools are enabled ## User Experience Improvements - **Optional Enhancement Badging**: Blue "Optional" badges to indicate MCP tools are not required - **Clear Navigation**: Direct links to GitHub repositories for easy access - **Pro Tips**: Professional guidance on gradual adoption approach - **Visual Structure**: Well-organized sections with emojis and clear headings ## Configuration Details ### English README.md - Added "MCP Tools Configuration (Optional Enhancement)" section - Quick MCP Setup with two installation options - Benefits breakdown with specific capability improvements - Configuration resources table with direct links ### Chinese README_CN.md - Added "MCP 工具配置 (可选增强)" section - Translated installation guides and benefits - Localized professional tips and guidance - Consistent structure with English version ## Technical Integration - **Automatic Detection**: CCW automatically detects and uses available MCP tools - **Fallback Strategy**: Traditional tools used when MCP unavailable - **IDE Integration**: Simple restart-based activation process - **No Breaking Changes**: Completely optional enhancement to existing functionality 🔧 Enhanced user onboarding and configuration guidance for MCP tools integration 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
36
README.md
36
README.md
@@ -434,6 +434,42 @@ Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/cat
|
||||
!**/CLAUDE.md
|
||||
```
|
||||
|
||||
### 🔧 **MCP Tools Configuration** *(Optional Enhancement)*
|
||||
|
||||
[](https://github.com/modelcontextprotocol)
|
||||
|
||||
**MCP (Model Context Protocol) tools provide enhanced codebase analysis capabilities. They are completely optional - CCW works perfectly without them.**
|
||||
|
||||
#### **Quick MCP Setup**
|
||||
1. **Install MCP Servers** (choose what you need):
|
||||
```bash
|
||||
# Option 1: Exa MCP Server (External API patterns)
|
||||
# 📋 Installation Guide: https://github.com/exa-labs/exa-mcp-server
|
||||
|
||||
# Option 2: Code Index MCP (Advanced code search)
|
||||
# 📋 Installation Guide: https://github.com/johnhuang316/code-index-mcp
|
||||
```
|
||||
|
||||
2. **Configure Claude Code IDE**:
|
||||
- Follow the MCP server installation guides above
|
||||
- Restart Claude Code IDE after MCP server installation
|
||||
- CCW will automatically detect and use available MCP tools
|
||||
|
||||
#### **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
|
||||
|
||||
#### **Configuration Resources**
|
||||
| MCP Server | Installation Guide | Purpose |
|
||||
|------------|-------------------|---------|
|
||||
| 🌐 **Exa MCP** | [Installation Guide](https://github.com/exa-labs/exa-mcp-server) | External API patterns & best practices |
|
||||
| 🔍 **Code Index MCP** | [Installation Guide](https://github.com/johnhuang316/code-index-mcp) | Advanced internal codebase search |
|
||||
| 📖 **MCP Protocol** | [Official Documentation](https://github.com/modelcontextprotocol) | Technical specifications |
|
||||
|
||||
> **💡 Pro Tip**: Start with basic CCW functionality, then add MCP tools when you want enhanced analysis capabilities.
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
36
README_CN.md
36
README_CN.md
@@ -606,6 +606,42 @@ apikeys.txt
|
||||
|
||||
**注意**: 与 `.gitignore` 不同,`.geminiignore` 仅影响Gemini CLI操作,不会影响Git版本控制。
|
||||
|
||||
### 🔧 **MCP 工具配置** *(可选增强)*
|
||||
|
||||
[](https://github.com/modelcontextprotocol)
|
||||
|
||||
**MCP (模型上下文协议) 工具提供增强的代码库分析能力。它们完全是可选的 - CCW 在没有它们的情况下也能完美工作。**
|
||||
|
||||
#### **快速 MCP 设置**
|
||||
1. **安装 MCP 服务器** (选择您需要的):
|
||||
```bash
|
||||
# 选项 1: Exa MCP Server (外部 API 模式)
|
||||
# 📋 安装指南: https://github.com/exa-labs/exa-mcp-server
|
||||
|
||||
# 选项 2: Code Index MCP (高级代码搜索)
|
||||
# 📋 安装指南: https://github.com/johnhuang316/code-index-mcp
|
||||
```
|
||||
|
||||
2. **配置 Claude Code IDE**:
|
||||
- 按照上述 MCP 服务器安装指南操作
|
||||
- 安装 MCP 服务器后重启 Claude Code IDE
|
||||
- CCW 将自动检测并使用可用的 MCP 工具
|
||||
|
||||
#### **启用后的好处**
|
||||
- 📊 **更快分析**: 直接代码库索引 vs 手动搜索
|
||||
- 🌐 **外部上下文**: 真实世界的 API 模式和示例
|
||||
- 🔍 **高级搜索**: 模式匹配和相似性检测
|
||||
- ⚡ **自动回退**: MCP 不可用时使用传统工具
|
||||
|
||||
#### **配置资源**
|
||||
| MCP 服务器 | 安装指南 | 用途 |
|
||||
|------------|---------|------|
|
||||
| 🌐 **Exa MCP** | [安装指南](https://github.com/exa-labs/exa-mcp-server) | 外部 API 模式和最佳实践 |
|
||||
| 🔍 **Code Index MCP** | [安装指南](https://github.com/johnhuang316/code-index-mcp) | 高级内部代码库搜索 |
|
||||
| 📖 **MCP 协议** | [官方文档](https://github.com/modelcontextprotocol) | 技术规范 |
|
||||
|
||||
> **💡 专业提示**: 从基本的 CCW 功能开始,然后在需要增强分析能力时添加 MCP 工具。
|
||||
|
||||
## 贡献
|
||||
|
||||
### 开发设置
|
||||
|
||||
Reference in New Issue
Block a user