@mmlotfy/intellicodemcp/QUICK_START.md

IntelliCodeMCP - Advanced AI Model Context Protocol System for intelligent code management and orchestration

# 🚀 IntelliCodeMCP - Quick Start Guide

## Installation & Setup

### 1. Prerequisites
- Node.js v16+ 
- npm v8+

### 2. Installation
```bash
# Navigate to project directory
cd mcp-project

# Install dependencies
npm install

# Build the project
npm run build
```

### 3. Verify Installation
```bash
# Show help
npm start

# Or use direct command
node dist/main/cli.js
```

## 🎯 Common Use Cases

### 1. Project Documentation Management
```bash
# Create project notes
npm start -- --tool memory_bank --action write --category docs --file_name project_notes.txt --content "Project requirements and specifications"

# Read project notes
npm start -- --tool memory_bank --action read --category docs --file_name project_notes.txt

# Search across all documentation
npm start -- --tool memory_bank --action search --category search --file_name search_docs.json --query "requirements"
```

### 6. Web Search
```bash
# Search the internet for real-time information
npm start -- --tool web_search --query "TypeScript best practices" --num_results 5

# Search with specific API key
npm start -- --tool web_search --query "React performance optimization" --num_results 3 --api_key "your_serpapi_key"
```

### 2. Code Quality Monitoring
```bash
# Check for TypeScript errors
npm start -- --tool code_trace --project_path . --check_type typescript

# Check and auto-fix ESLint issues
npm start -- --tool code_trace --project_path . --check_type eslint --fix

# Comprehensive code check
npm start -- --tool code_trace --project_path . --check_type all
```

### 3. Task Management
```bash
# Create a task record
npm start -- --tool memory_bank --action write --category knots --file_name task_001.txt --content "Task: Implement user authentication\nPriority: High\nStatus: In Progress"

# Track conversation about the task
npm start -- --tool memory_bank --action write --category threads --file_name thread_auth.txt --content "Discussion about authentication implementation"

# Generate summary of the conversation
npm start -- --tool smartcontext_weaver --thread_id thread_auth
```

### 4. Problem Solving
```bash
# Analyze a complex problem
npm start -- --tool smartthink_weaver --problem "How to optimize database performance" --context "Current system has slow queries"

# Get AI-powered solution with search context
npm start -- --tool smartthink_weaver --problem "Implement secure API authentication" --query "security best practices"
```

### 5. Intelligent Task Orchestration
```bash
# Simple task - will use Gemini 2.5 Pro
npm start -- --tool performance_orchestrator --task '{"id":"fix1","input":"Fix typo in documentation","priority":"low"}'

# Complex coding task - will use Claude
npm start -- --tool performance_orchestrator --task '{"id":"dev1","input":"Implement user registration system","priority":"high"}'

# Analytical task - will use Grok
npm start -- --tool performance_orchestrator --task '{"id":"analysis1","input":"Analyze system performance bottlenecks","priority":"medium"}'
```

## 📁 Understanding the Data Structure

### IntelliMemory Hub Organization
```
intelliMemoryHub/
├── docs/
│   ├── vision.txt              # Project vision
│   ├── weaver_summaries/       # Context summaries
│   ├── think_summaries/        # Analysis results
│   └── search_results/         # Search outputs
├── threads/                    # Conversation records
├── knots/                      # Task/issue tracking
├── technical/
│   ├── performance_logs/       # System performance data
│   └── error_reports/          # Code error tracking
└── model_profiles/             # AI model configurations
```

### File Naming Conventions
- **Threads**: `thread_001.txt`, `thread_auth.txt`
- **Tasks**: `knot_001.txt`, `task_feature.txt`
- **Logs**: Auto-generated with timestamps
- **Summaries**: Auto-generated with timestamps

## 🔧 Configuration Tips

### 1. Customize AI Model Preferences
Edit `.roo/code-intelligence.yaml`:
```yaml
performance:
  model_selection:
    simple: "Gemini-2.5-Pro"      # Fast tasks
    code_writing: "Claude"         # High-quality code
    analytical: "Grok"             # Logical reasoning
    complex: "DeepSeek"            # Detailed analysis
```

### 2. Adjust Search Settings
```yaml
integrations:
  search:
    enabled: true
    max_results: 50
    result_directory: "intelliMemoryHub/docs/search_results/"
```

## 🎯 Best Practices

### 1. Organize Your Data
- Use descriptive file names
- Keep related conversations in the same thread
- Tag tasks with priority and status

### 2. Leverage Search
- Use specific keywords for better results
- Search before creating new content
- Review search results for context

### 3. Monitor Performance
- Check performance logs regularly
- Use appropriate task types for better model selection
- Monitor error reports for code quality

## 🆘 Troubleshooting

### Common Issues

**Build Errors:**
```bash
npm run clean
npm install
npm run build
```

**Permission Issues (Linux/Mac):**
```bash
chmod +x dist/main/cli.js
```

**Search Not Working:**
- Ensure files exist in intelliMemoryHub
- Check file permissions
- Verify search index is updated

### Getting Help
```bash
# Show available tools
npm start

# Show tool-specific help
npm start -- --tool memory_bank

# Check system status
npm run lint
```

## 🚀 Next Steps

1. **Explore Advanced Features**: Try multi-agent reasoning with SmartThink Weaver
2. **Integrate with Your Workflow**: Set up regular code quality checks
3. **Customize Configuration**: Adjust AI model preferences for your needs
4. **Scale Up**: Use for larger projects and team collaboration

Happy coding with IntelliCodeMCP! 🎉