🧠 ContextIQ - Smart Context for GitHub Copilot

🌟 What Makes This Special?

"Remember this pattern" → Copilot stores it with related files and symbols
"Save as rule: Always use TypeScript strict mode" → Applied automatically in every chat
"Find all usages of AuthService" → Instant cross-file symbol search

✨ Key Highlights

🚀 Features

🧠 Intelligent Knowledge Storage

Store and retrieve coding knowledge with natural language:

"Remember this: React useEffect cleanup prevents memory leaks"
"Retrieve knowledge about authentication"
"What patterns did I save for error handling?"

Smart Features:

• 📁 Auto-links active file when storing knowledge
• 🔗 Extracts related symbols from content (functions, classes, imports)
• 📊 Discovers related files through import analysis
• 🏷️ Tag-based organization with full-text search

📋 Automatic Rules System

Define rules that Copilot follows automatically:

"Save as rule: Use 2-space indentation, never tabs"
"Remember rule: All API calls go through ApiService"
"Add rule: Minimum 80% test coverage required"

How It Works:

1. You define a rule → Stored with category and priority
2. Every chat session → Rules auto-loaded at start
3. Copilot writes code → Follows your rules automatically

🔍 Code Indexing & Symbol Search

Index your entire codebase for instant symbol lookup:

"Search for AuthService class"
"Find all functions named handleSubmit"
"What files import the UserContext?"

Supported Languages (27+): TypeScript JavaScript Python Rust Go Java C/C++ C# Ruby PHP Swift Kotlin Scala Dart Lua R Julia Elixir Clojure Haskell OCaml F# Zig Nim Crystal V Odin

🎯 Smart Context System

NEW in v1.3.0! The extension now automatically enriches stored knowledge:

┌─────────────────────────────────────────────────────────┐
│  You're editing: src/services/AuthService.ts            │
│  You say: "Remember this OAuth implementation"          │
├─────────────────────────────────────────────────────────┤
│  ✅ Content stored                                       │
│  📁 Active file: src/services/AuthService.ts            │
│  🔗 Related files: UserService.ts, TokenManager.ts      │
│  📍 Related symbols: OAuth2Client, refreshToken()       │
└─────────────────────────────────────────────────────────┘

Automatic Entity Extraction:

• File paths from code blocks and inline references
• Import statements and module dependencies
• Function calls and class references
• Symbol names for cross-referencing

⚡ Performance

Optimizations:

• 💾 SQLite WAL mode with 64MB cache
• 📊 Prepared statement caching
• 🔄 Persistent MCP server (no spawn overhead)
• 🗂️ Memory-mapped I/O (30GB mmap)

📦 Installation

From VSIX (Recommended)

1. Download contextiq-1.3.0.vsix
2. Press Cmd/Ctrl + Shift + P → "Extensions: Install from VSIX"
3. Select the downloaded file
4. Reload VS Code

From Source

# Clone and navigate to extension
cd copilot-memory-mcp/extension

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Package extension
npm run package

# Install the .vsix file
code --install-extension contextiq-1.3.0.vsix

🎮 Quick Start

Step 1: Open the Sidebar

Click the 🧠 ContextIQ icon in the VS Code activity bar.

Step 2: One-Click Setup

Choose your preferred method:

Step 3: Start Using

Open GitHub Copilot Chat and try:

"Remember this: Always validate user input before database operations"

"Save as rule: Use async/await instead of .then() chains"

"Retrieve knowledge about error handling"

"Search for UserService class"

🎯 Smart Context System

How It Works

When you store knowledge, the system automatically:

┌─────────────────────────────────────────────────────────────┐
│                    SMART CONTEXT FLOW                        │
├─────────────────────────────────────────────────────────────┤
│                                                              │
│  1. CONTENT ANALYSIS                                         │
│     ├── Extract file paths (./src/utils/helpers.ts)         │
│     ├── Parse import statements                              │
│     └── Identify function/class names                        │
│                                                              │
│  2. SYMBOL LOOKUP                                            │
│     ├── Search indexed codebase for mentioned symbols        │
│     └── Find related definitions and usages                  │
│                                                              │
│  3. FILE DISCOVERY                                           │
│     ├── Analyze import relationships                         │
│     └── Link related files through dependencies              │
│                                                              │
│  4. CONTEXT ATTACHMENT                                       │
│     ├── Active file → Automatically tracked                  │
│     ├── Related files → JSON array stored                    │
│     └── Related symbols → With file and line info            │
│                                                              │
└─────────────────────────────────────────────────────────────┘

Retrieval Enhancement

When you retrieve knowledge, you get enriched results:

🧠 Found 3 entries:

[PROJECT] Authentication implementation using JWT tokens
  📁 Active file: src/services/AuthService.ts
  🔗 Related: UserService.ts, TokenManager.ts, middleware/auth.ts
  📍 Symbols: verifyToken(), refreshSession(), AuthContext

[GLOBAL] Error handling patterns for async operations
  📍 Symbols: AsyncErrorBoundary, handleApiError()

📋 Rules System

Creating Rules

"Save as rule: Never use any in TypeScript, always define proper types"

Copilot stores:

{
  title: "No Any Types",
  content: "Never use 'any' in TypeScript, always define proper types",
  category: "code-style",
  priority: 8,
  enabled: true
}

Rule Categories

Priority System

Managing Rules

"List all my rules"           → Shows all rules with IDs
"Update rule abc123 priority to 10"
"Disable rule xyz789"
"Delete rule abc123"

🔍 Code Indexing

Indexing Your Workspace

The extension can index your entire codebase:

"Index this workspace"        → Full workspace indexing
"Index this file"             → Single file indexing
"Get index statistics"        → View indexed files/symbols

Symbol Search

"Search for handleSubmit"     → Find all functions named handleSubmit
"Find UserService class"      → Locate class definitions
"What files use AuthContext"  → Find imports and usages

Symbol Kinds

🔧 MCP Tools Reference

Knowledge Tools (3)

Rules Tools (5)

Code Indexing Tools (6)

⚙️ Configuration

VS Code Settings

{
  "copilotMemory.storage.local.dataDir": "~/.copilot-memory",
  "copilotMemory.storage.local.projectSpecific": true,
  "copilotMemory.mcp.autoStart": true,
  "copilotMemory.logging.level": "info"
}

Multi-Scope Storage

MCP Configuration

Auto-generated when you click Copy MCP Configuration:

{
  "mcpServers": {
    "contextiq": {
      "command": "node",
      "args": ["/path/to/server/index-sqlite.js"],
      "description": "ContextIQ - Smart context for smarter code"
    }
  }
}

🎮 Commands

🐛 Troubleshooting

Rules Not Applied

1. Click 📝 Update Copilot Instructions
2. Check .github/copilot-instructions.md exists
3. Verify [copilot-memory-mcp] section is present
4. Reload VS Code

Database Errors

# Delete corrupted database (data will be lost)
rm ~/.copilot-memory/{project}.db

# Reopen VS Code - fresh database created

Server Won't Start

1. Check Node.js: node --version (requires 18+)
2. Verify server path in settings
3. Check Output panel for errors

Slow Performance

"List knowledge with optimize: true"  → Runs VACUUM and ANALYZE

📁 Project Structure

contextiq/
├── extension/
│   ├── src/
│   │   ├── extension.ts           # Main entry point
│   │   ├── embeddedMCPServerSQLite.ts
│   │   ├── activeFileTracker.ts   # Smart context tracking
│   │   ├── memoryTreeProvider.ts  # Sidebar UI
│   │   └── configuration.ts
│   └── package.json
│
├── server/
│   ├── index-sqlite.js            # MCP server (14 tools)
│   ├── contextEnricher.js         # Entity extraction
│   └── package.json
│
└── .github/
    └── copilot-instructions.md    # Auto-generated

📝 Changelog

v1.3.0 (Current) 🎉

• ✨ Smart Context System - Auto-tracks files, symbols, and relationships
• 🔗 Entity Extraction - Parses file paths, imports, and symbol names
• 📁 Active File Tracking - Links knowledge to current editor file
• 🔄 Automatic Migration - Seamless upgrade from older versions
• 🐛 FTS5 Rebuild - Fixed migration for existing databases

v1.2.0

• 🔍 Code Indexing - 27+ language support
• 📊 Symbol Search - Cross-file function/class lookup
• 📈 Index Statistics - Workspace analysis

v1.1.0

• 📋 Rules System - Automatic coding guidelines
• ⚡ 25-80x Faster - Performance optimizations
• 🚀 One-Click Setup - Simplified installation

v1.0.0

• 🎉 Initial release
• 🧠 Knowledge storage with FTS5
• 📁 Project-specific databases

🤝 Contributing

1. Fork the repository
2. Create feature branch: git checkout -b feature/amazing
3. Commit changes: git commit -m 'Add amazing feature'
4. Push: git push origin feature/amazing
5. Open Pull Request

📄 License

MIT License - see LICENSE for details.