Coding Agents search blindly. Be their guide.
Installation • Quick Start • Configuration • MCP Tools • Contributing
CICADA is a Model Context Protocol (MCP) server that provides AI coding assistants with deep code intelligence. Currently supports Elixir projects, with Python and TypeScript support planned for future releases. It indexes your codebase using tree-sitter AST parsing and provides instant access to modules, functions, call sites, and PR attribution.
| Without CICADA | With CICADA |
| 3,127 tokens • 52.84s | 550 tokens • 35.04s |
| 82.4% fewer tokens • 33.7% faster | |
- AST-aware code search - Find function definitions with full signatures, types, and documentation—no implementation bloat
- Intelligent call site tracking - Resolve aliases and track where functions are actually invoked across the codebase
- PR attribution & review context - Discover which pull request introduced any line and view historical code review discussions inline
- Function evolution tracking - See when functions were created, how often they’re modified, and their complete git history
- Semantic module analysis - Understand module dependencies, imports, and relationships beyond text matching
- MCP integration - Provide AI coding assistants with structured code intelligence, not raw text
Installing UV:
curl -LsSf https://astral.sh/uv/install.sh | sh
# or: brew install uvInstall Cicada permanently for best experience:
# Step 1: Install once
uv tool install git+https://github.com/wende/cicada.git@latest
# Step 2: Setup in each project (one command per project)
cd /path/to/your/elixir/project
cicada claude # or: cicada cursor, cicada vsThat's it! The setup command:
- Indexes your codebase with keyword extraction
- Stores all files in
~/.cicada/projects/<hash>/(outside your repo) - Creates only an MCP config file in your repo (
.mcp.jsonfor Claude Code) - Configures the MCP server automatically
After setup:
- Restart your editor
- Start coding with AI-powered Elixir intelligence!
Available commands after installation:
cicada [claude|cursor|vs]- One-command setup per projectcicada-server- MCP server (auto-started by editor)cicada-index- Re-index code with custom options (medium/large spaCy models)cicada-index-pr- Index pull requests for PR attributioncicada-install- Legacy setup (creates.cicada/in repo)
Want to test Cicada first? Use uvx for a quick trial:
cd /path/to/your/elixir/project
# For Claude Code
uvx --from git+https://github.com/wende/cicada.git@latest cicada claude
# For Cursor
uvx --from git+https://github.com/wende/cicada.git@latest cicada cursor
# For VS Code
uvx --from git+https://github.com/wende/cicada.git@latest cicada vsNote: uvx is perfect for trying Cicada, but permanent installation is recommended because:
- ✅ Faster MCP server startup (no temporary environment creation)
- ✅ Access to all CLI commands (
cicada-index,cicada-index-pr) - ✅ Fine-tuned keyword extraction with medium/large spaCy models
- ✅ PR indexing features
- ✅ Custom re-indexing options
Once you're convinced, install permanently with uv tool install above!
For Cursor:
Click the install button at the top of this README or visit:
For Claude Code:
# Option 1: Using claude mcp add command
claude mcp add cicada -- uvx --from git+https://github.com/wende/cicada.git@latest cicada-server ./path/to/your/codebase
# Option 2: Using setup script
uvx --from git+https://github.com/wende/cicada.git@latest cicada claudeThen for both editors, run these commands in your codebase to generate keyword lookup and GitHub PR lookup databases:
# Generate keyword lookup database
uvx --from git+https://github.com/wende/cicada.git@latest cicada-index .
# Generate GitHub PR lookup database
uvx --from git+https://github.com/wende/cicada.git@latest cicada-index-pr .After installation, ask your AI coding assistant:
"What functions are in the MyApp.User module?"
"Show me where authenticate/2 is called"
"Which PR introduced line 42 of user.ex?"
"Show me all PRs that modified the User module with their review comments"
"Find all usages of Repo.insert/2"
"What's the git history of the authenticate function?"
For PR features, first run:
cicada-index-pr .The new simplified workflow stores all generated files outside your repository:
Storage Structure:
~/.cicada/
projects/
<repo-hash>/
config.yaml # MCP server configuration
index.json # Code index with keywords
pr_index.json # PR attribution data (optional)
hashes.json # For incremental indexing
Your Repository (Clean!):
your-project/
.mcp.json # Only this file is added (for Claude Code)
# or .cursor/mcp.json for Cursor
# or .vscode/settings.json for VS Code
Generated MCP Config (Claude Code example):
{
"mcpServers": {
"cicada": {
"command": "cicada-server",
"env": {
"CICADA_REPO_PATH": "/path/to/project",
"CICADA_CONFIG_DIR": "/home/user/.cicada/projects/<hash>"
}
}
}
}After code changes, re-run the setup command:
# Re-index for Claude Code
uvx --from git+https://github.com/wende/cicada.git@latest cicada claude
# Or if permanently installed
cicada claudeThis will:
- Detect changed files (incremental indexing)
- Update the index with new/modified code
- Keep your existing MCP configuration
Index pull requests for PR-related features:
# After permanent installation
cicada-index-pr .
# Or with uvx
uvx --from git+https://github.com/wende/cicada.git@latest cicada-index-pr .If you prefer the old setup (stores files in .cicada/ directory in your repo):
# Only available after permanent installation
cicada-installSee also: PR Indexing Documentation
CICADA provides 9 specialized tools for AI assistants to understand and navigate your codebase. For complete technical documentation including parameters and return formats, see MCP Tools Reference.
search_module - Find modules and view all their functions
- Search by exact module name or file path
- View function signatures with type specs
- Filter public/private functions
- Output in Markdown or JSON
search_function - Locate function definitions and track usage
- Search by function name, arity, or full module path
- See where functions are called with line numbers
- View actual code usage examples
- Filter for test files only
search_module_usage - Track module dependencies
- Find all aliases and imports
- See all function calls to a module
- Understand module relationships
- Map dependencies across codebase
find_pr_for_line - Identify which PR introduced any line of code
- Line-level PR attribution via git blame
- Author and commit information
- Direct links to GitHub PRs
- Requires: GitHub CLI + PR index
get_file_pr_history - View complete PR history for a file
- All PRs that modified the file
- PR descriptions and metadata
- Code review comments with line numbers
- Requires: GitHub CLI + PR index
get_commit_history - Track file and function evolution over time
- Complete commit history for files
- Function-level tracking (follows refactors)
- Creation and modification timeline
- Requires:
.gitattributesconfiguration
get_blame - Show line-by-line code ownership
- Grouped authorship display
- Commit details for each author
- Code snippets with context
search_by_keywords (EXPERIMENTAL) - Semantic documentation search
- Find code by concepts, not just names
- Wildcard pattern matching (
create*,*_user) - NLP-extracted keywords from docs
- Relevance scoring
- Requires: Index built with
--extract-keywords
find_dead_code - Identify potentially unused functions
- Three confidence levels (high, medium, low)
- Smart detection of callbacks and behaviors
- Recognition of dynamic call patterns
- Module-level grouping with line numbers
- Excludes test files and
@implfunctions
See also: Complete MCP Tools Reference for detailed specifications
CICADA provides several command-line tools for setup, indexing, and analysis:
cicada - Initialize CICADA in your project
cicada # Setup in current directory
cicada --skip-install # Skip dependency installation
cicada /path/to/other/project # Setup in different directory- Generates
.mcp.jsonconfiguration - Creates
.cicada/directory - Installs Elixir dependencies
- Configures git attributes for function tracking
cicada-index - Index Elixir codebase
cicada-index # Index current directory
cicada-index --output .cicada/index.json
cicada-index --extract-keywords # Include NLP keyword extraction- Parses all Elixir files using tree-sitter
- Extracts modules, functions, and call sites
- Resolves aliases for accurate tracking
- Optional keyword extraction for semantic search
cicada-index-pr - Index GitHub pull requests
cicada-index-pr . # Index PRs for current repo
cicada-index-pr . --clean # Full rebuild from scratch- Requires GitHub CLI (
gh) authenticated - Indexes PR metadata and review comments
- Incremental updates by default
- Enables PR attribution features
cicada-find-dead-code - Find unused functions (CLI version)
cicada-find-dead-code # Show high confidence only
cicada-find-dead-code --min-confidence low # Show all candidates
cicada-find-dead-code --format json # JSON output
cicada-find-dead-code --index path/to/index.json- Analyzes function usage across codebase
- Categorizes by confidence level
- Available as both CLI tool and MCP tool
- Module and function search
- Call site tracking with alias resolution
- PR attribution via git blame + GitHub
- PR review comments with line mapping
- File PR history with descriptions
- GraphQL-based PR indexing (30x faster)
- Function usage examples with code snippets
- Git commit history tracking with precise function tracking
- Function evolution metadata (creation, modifications, frequency)
- Git blame integration with line-by-line authorship
- Test file filtering
- Multiple output formats (markdown, JSON)
- Intelligent .mcp.json auto-configuration
uv tool installsupport- Automatic version update checking - Notifies users when newer versions are available
- NLP Keyword search (EXPERIMENTAL) - Semantic search across documentation with wildcard support
- Incremental code re-indexing
- Enhanced keyword search with BM25 ranking
- RAG with KeyBERT option (??)
- Multi-language support (Python, TypeScript)
- Semantic code search
- Real-time incremental indexing
- Web UI for exploration
These features are explicitly not planned:
- Fuzzy search / "did you mean" suggestions (grep is sufficient)
- Function similarity algorithms or recommendations
- Confidence scoring systems
- Multi-repository support (single repo focus)
- Alternative function suggestions (bang/non-bang variants)
CICADA prioritizes simplicity and reliability over complexity:
- Exact name matching only - Use grep/ripgrep for fuzzy searches; keeping CICADA focused
- Direct call tracking - Tracks explicit function calls; comprehensive call graphs add complexity without enough value
- Manual documentation search - Documentation indexing planned for v0.1
- No AI/ML features - No similarity algorithms, confidence scoring, or recommendations; deterministic results only
These are deliberate design choices to keep CICADA fast, predictable, and maintainable.
# Clone your fork
git clone https://github.com/wende/cicada.git
cd cicada
# Using uv (recommended)
uv sync
# Or traditional venv (legacy)
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
pip install -e ".[dev]"
# Run tests
pytest# Run all tests
pytest
# Run specific test files
pytest tests/test_parser.py
pytest tests/test_search_function.py
# Run with coverage (terminal report)
pytest --cov=cicada --cov-report=term-missing
# Generate HTML coverage report
pytest --cov=cicada --cov-report=html
# Open htmlcov/index.html in your browser
# Run with coverage and see which lines need tests
pytest --cov=cicada --cov-report=term-missing --cov-report=html
# Check coverage and fail if below threshold (e.g., 80%)
pytest --cov=cicada --cov-fail-under=80This project uses:
- black for code formatting
- pytest for testing
- type hints where appropriate
Before submitting a PR:
# Format code
black cicada tests
# Run tests
pytest
# Check types (if using mypy)
mypy cicadaWhen reporting bugs or requesting features:
- Check existing Issues
- If not found, create a new issue with:
- Clear description
- Steps to reproduce (for bugs)
- Expected vs actual behavior
- Your environment (OS, Python version, Elixir version)
Run the indexer first:
cicada-index /path/to/projectUse the exact module name as it appears in code (e.g., MyApp.User, not User).
- Verify
.mcp.jsonexists in your project root - Check that all paths in
.mcp.jsonare absolute - Ensure
index.jsonwas created successfully - Restart your MCP client (Claude Code, Cline, etc.)
- Check your MCP client logs for errors
PR features require the GitHub CLI and a PR index:
# Install GitHub CLI
brew install gh # macOS
# or visit https://cli.github.com/
# Authenticate
gh auth login
# Index PRs (first time or after new PRs)
cicada-index-pr .
# Clean rebuild (re-index everything from scratch)
cicada-index-pr . --cleanCommon issues:
- "No PR index found" → Run
cicada-index-pr . - "Not a GitHub repository" → Ensure repo has GitHub remote
- Slow indexing → Incremental updates are used by default
Remove CICADA from a project:
rm -rf .cicada/ .mcp.json
# Restart your MCP client- Tree-sitter - Incremental parsing system
- tree-sitter-elixir - Elixir grammar
- MCP - Model Context Protocol
- GitHub CLI - PR attribution
This project is licensed under the MIT License - see the LICENSE file for details.
- The Anthropic team for Claude Code and MCP
- The Elixir community for tree-sitter-elixir
- All contributors who help improve CICADA