mcp-code-indexer 3.6.0__tar.gz → 4.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/PKG-INFO +92 -13
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/README.md +91 -12
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/pyproject.toml +1 -1
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/server/mcp_server.py +13 -1
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/LICENSE +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/__init__.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/__main__.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/ask_handler.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/claude_api_handler.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/cleanup_manager.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/commands/__init__.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/commands/makelocal.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/data/stop_words_english.txt +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/__init__.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/connection_health.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/database.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/database_factory.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/exceptions.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/models.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/path_resolver.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/retry_executor.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/deepask_handler.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/error_handler.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/file_scanner.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/git_hook_handler.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/logging_config.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/main.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/middleware/__init__.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/middleware/auth.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/middleware/error_middleware.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/middleware/logging.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/middleware/security.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/migrations/001_initial.sql +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/migrations/002_performance_indexes.sql +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/migrations/003_project_overviews.sql +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/migrations/004_remove_branch_dependency.sql +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/migrations/005_remove_git_remotes.sql +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/query_preprocessor.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/server/__init__.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/tiktoken_cache/9b5ad71b2ce5302211f9c61530b329a4922fc6a4 +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/token_counter.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/tools/__init__.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/transport/__init__.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/transport/base.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/transport/http_transport.py +0 -0
- {mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/transport/stdio_transport.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.3
|
|
2
2
|
Name: mcp-code-indexer
|
|
3
|
-
Version:
|
|
3
|
+
Version: 4.0.1
|
|
4
4
|
Summary: MCP server that tracks file descriptions across codebases, enabling AI agents to efficiently navigate and understand code through searchable summaries and token-aware overviews.
|
|
5
5
|
License: MIT
|
|
6
6
|
Keywords: mcp,model-context-protocol,code-indexer,ai-tools,codebase-navigation,file-descriptions,llm-tools
|
|
@@ -43,8 +43,8 @@ Description-Content-Type: text/markdown
|
|
|
43
43
|
|
|
44
44
|
# MCP Code Indexer 🚀
|
|
45
45
|
|
|
46
|
-
[](https://badge.fury.io/py/mcp-code-indexer)
|
|
47
|
+
[](https://pypi.org/project/mcp-code-indexer/)
|
|
48
48
|
[](https://opensource.org/licenses/MIT)
|
|
49
49
|
|
|
50
50
|
A production-ready **Model Context Protocol (MCP) server** that revolutionizes how AI agents navigate and understand codebases. Built for high-concurrency environments with advanced database resilience, the server provides instant access to intelligent descriptions, semantic search, and context-aware recommendations while maintaining 800+ writes/sec throughput.
|
|
@@ -80,6 +80,43 @@ mcp-code-indexer
|
|
|
80
80
|
# See API Reference for complete tool documentation
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
+
### 🌐 For Web Applications
|
|
84
|
+
|
|
85
|
+
Enable HTTP/REST API access for browser-based applications:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
# Start HTTP server with authentication
|
|
89
|
+
mcp-code-indexer --http --auth-token "your-secret-token"
|
|
90
|
+
|
|
91
|
+
# Custom host and port
|
|
92
|
+
mcp-code-indexer --http --host 0.0.0.0 --port 8080
|
|
93
|
+
|
|
94
|
+
# CORS configuration for web apps
|
|
95
|
+
mcp-code-indexer --http --cors-origins "https://localhost:3000" "https://myapp.com"
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
**🔗 [Complete HTTP API Reference →](docs/http-api.md)**
|
|
99
|
+
|
|
100
|
+
### 🤖 For AI-Powered Q&A
|
|
101
|
+
|
|
102
|
+
Ask questions about your codebase using natural language:
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
# Set OpenRouter API key for Claude access
|
|
106
|
+
export OPENROUTER_API_KEY="your-openrouter-api-key"
|
|
107
|
+
|
|
108
|
+
# Simple questions about project architecture
|
|
109
|
+
mcp-code-indexer --ask "What does this project do?" my-project
|
|
110
|
+
|
|
111
|
+
# Enhanced analysis with file search
|
|
112
|
+
mcp-code-indexer --deepask "How is authentication implemented?" web-app
|
|
113
|
+
|
|
114
|
+
# JSON output for programmatic use
|
|
115
|
+
mcp-code-indexer --ask "List the main components" my-project --json
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
**🤖 [Complete Q&A Interface Guide →](docs/qa-interface.md)**
|
|
119
|
+
|
|
83
120
|
### 🔧 For System Administrators
|
|
84
121
|
|
|
85
122
|
Deploy and configure the server for your team:
|
|
@@ -309,12 +346,16 @@ Comprehensive documentation organized by user journey and expertise level.
|
|
|
309
346
|
| Guide | Purpose | Time Investment |
|
|
310
347
|
|-------|---------|-----------------|
|
|
311
348
|
| **[Quick Start](#-quick-start)** | Install and run your first server | 2 minutes |
|
|
312
|
-
| **[Git Hook Setup](docs/git-hook-setup.md)** | Automate your workflow | 5 minutes |
|
|
313
349
|
| **[API Reference](docs/api-reference.md)** | Master all 11 MCP tools | 15 minutes |
|
|
350
|
+
| **[HTTP API Reference](docs/http-api.md)** | REST API for web applications | 10 minutes |
|
|
351
|
+
| **[Q&A Interface](docs/qa-interface.md)** | AI-powered codebase analysis | 8 minutes |
|
|
352
|
+
| **[Git Hook Setup](docs/git-hook-setup.md)** | Automate your workflow | 5 minutes |
|
|
314
353
|
|
|
315
354
|
### 🏗️ Production Deployment (Teams & Admins)
|
|
316
355
|
| Guide | Focus | Best For |
|
|
317
356
|
|-------|-------|----------|
|
|
357
|
+
| **[CLI Reference](docs/cli-reference.md)** | Complete command documentation | All users |
|
|
358
|
+
| **[Administrative Commands](docs/admin-commands.md)** | Project & database management | System administrators |
|
|
318
359
|
| **[Configuration Guide](docs/configuration.md)** | Production setup & tuning | System administrators |
|
|
319
360
|
| **[Performance Tuning](docs/performance-tuning.md)** | High-concurrency optimization | DevOps teams |
|
|
320
361
|
| **[Monitoring & Diagnostics](docs/monitoring.md)** | Production monitoring | Operations teams |
|
|
@@ -332,8 +373,10 @@ Comprehensive documentation organized by user journey and expertise level.
|
|
|
332
373
|
- **[API Tools Summary](#🛠️-mcp-tools-available)** - All 11 tools at a glance
|
|
333
374
|
|
|
334
375
|
**📚 Reading Paths:**
|
|
335
|
-
- **New to MCP Code Indexer?** Quick Start →
|
|
336
|
-
- **
|
|
376
|
+
- **New to MCP Code Indexer?** Quick Start → API Reference → HTTP API → Q&A Interface
|
|
377
|
+
- **Web developers?** Quick Start → HTTP API Reference → Q&A Interface → Git Hooks
|
|
378
|
+
- **AI/ML engineers?** Quick Start → Q&A Interface → API Reference → Git Hooks
|
|
379
|
+
- **Setting up for a team?** CLI Reference → Configuration → Administrative Commands → Monitoring
|
|
337
380
|
- **Contributing to the project?** Architecture → Contributing → API Reference
|
|
338
381
|
|
|
339
382
|
## 🚦 System Requirements
|
|
@@ -518,7 +561,31 @@ mcp-code-indexer --githook [OPTIONS]
|
|
|
518
561
|
# Requires: OPENROUTER_API_KEY environment variable
|
|
519
562
|
```
|
|
520
563
|
|
|
521
|
-
###
|
|
564
|
+
### HTTP Server Mode
|
|
565
|
+
```bash
|
|
566
|
+
# Start HTTP/REST API server
|
|
567
|
+
mcp-code-indexer --http [OPTIONS]
|
|
568
|
+
|
|
569
|
+
# HTTP server with authentication
|
|
570
|
+
mcp-code-indexer --http --auth-token "your-secret-token"
|
|
571
|
+
|
|
572
|
+
# Custom host and port configuration
|
|
573
|
+
mcp-code-indexer --http --host 0.0.0.0 --port 8080
|
|
574
|
+
```
|
|
575
|
+
|
|
576
|
+
### Q&A Commands
|
|
577
|
+
```bash
|
|
578
|
+
# Simple AI-powered questions (requires OPENROUTER_API_KEY)
|
|
579
|
+
mcp-code-indexer --ask "What does this project do?" PROJECT_NAME
|
|
580
|
+
|
|
581
|
+
# Enhanced analysis with file search
|
|
582
|
+
mcp-code-indexer --deepask "How is authentication implemented?" PROJECT_NAME
|
|
583
|
+
|
|
584
|
+
# JSON output for programmatic use
|
|
585
|
+
mcp-code-indexer --ask "Question" PROJECT_NAME --json
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
### Administrative Commands
|
|
522
589
|
```bash
|
|
523
590
|
# List all projects
|
|
524
591
|
mcp-code-indexer --getprojects
|
|
@@ -528,6 +595,12 @@ mcp-code-indexer --runcommand '{"method": "tools/call", "params": {...}}'
|
|
|
528
595
|
|
|
529
596
|
# Export descriptions for a project
|
|
530
597
|
mcp-code-indexer --dumpdescriptions PROJECT_ID
|
|
598
|
+
|
|
599
|
+
# Create local database for a project
|
|
600
|
+
mcp-code-indexer --makelocal /path/to/project
|
|
601
|
+
|
|
602
|
+
# Generate project documentation map
|
|
603
|
+
mcp-code-indexer --map PROJECT_NAME
|
|
531
604
|
```
|
|
532
605
|
|
|
533
606
|
## 🛡️ Security Features
|
|
@@ -546,8 +619,10 @@ mcp-code-indexer --dumpdescriptions PROJECT_ID
|
|
|
546
619
|
|-------|-----------|------------|
|
|
547
620
|
| **"No module named 'mcp_code_indexer'"** | `pip install -e .` (for development) | [Contributing Guide](docs/contributing.md#development-setup) |
|
|
548
621
|
| **"OPENROUTER_API_KEY not found"** | `export OPENROUTER_API_KEY="your-key"` | [Git Hook Setup](docs/git-hook-setup.md#prerequisites) |
|
|
549
|
-
| **"Database is locked"** | Enable WAL mode: `--enable-wal-mode` | [
|
|
622
|
+
| **"Database is locked"** | Enable WAL mode: `--enable-wal-mode` | [CLI Reference](docs/cli-reference.md#database-configuration) |
|
|
550
623
|
| **"Large codebase - use search"** | Normal for 200+ files. Use `search_descriptions` | [API Reference](docs/api-reference.md#search_descriptions) |
|
|
624
|
+
| **HTTP authentication failed** | Check `--auth-token` configuration | [HTTP API Reference](docs/http-api.md#authentication) |
|
|
625
|
+
| **Q&A commands not working** | Set `OPENROUTER_API_KEY` environment variable | [Q&A Interface](docs/qa-interface.md#getting-started) |
|
|
551
626
|
| **High memory usage** | Reduce token limit: `--token-limit 10000` | [Configuration Guide](docs/configuration.md#performance-tuning) |
|
|
552
627
|
|
|
553
628
|
**💡 Not finding your issue?** Check the [complete troubleshooting guides](docs/monitoring.md#troubleshooting-runbook) in our documentation.
|
|
@@ -560,13 +635,17 @@ Ready to supercharge your AI agents with intelligent codebase navigation?
|
|
|
560
635
|
|
|
561
636
|
**🆕 New to MCP Code Indexer?**
|
|
562
637
|
1. **[Install and run your first server](#-quick-start)** - Get up and running in 2 minutes
|
|
563
|
-
2. **[
|
|
564
|
-
3. **[
|
|
638
|
+
2. **[Master the API tools](docs/api-reference.md)** - Learn all 11 tools with examples
|
|
639
|
+
3. **[Try HTTP API access](docs/http-api.md)** - REST API for web applications
|
|
640
|
+
4. **[Explore AI-powered Q&A](docs/qa-interface.md)** - Ask questions about your code
|
|
641
|
+
5. **[Set up git hooks](docs/git-hook-setup.md)** - Automate your workflow
|
|
565
642
|
|
|
566
643
|
**👥 Setting up for a team?**
|
|
567
|
-
1. **[
|
|
568
|
-
2. **[
|
|
569
|
-
3. **[
|
|
644
|
+
1. **[Learn all CLI commands](docs/cli-reference.md)** - Complete command reference
|
|
645
|
+
2. **[Configure for production](docs/configuration.md)** - Production deployment guide
|
|
646
|
+
3. **[Set up administrative workflows](docs/admin-commands.md)** - Project & database management
|
|
647
|
+
4. **[Performance optimization](docs/performance-tuning.md)** - High-concurrency setup
|
|
648
|
+
5. **[Monitoring & alerts](docs/monitoring.md)** - Production monitoring
|
|
570
649
|
|
|
571
650
|
**🔧 Want to contribute?**
|
|
572
651
|
1. **[Understand the architecture](docs/architecture.md)** - Technical deep dive
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# MCP Code Indexer 🚀
|
|
2
2
|
|
|
3
|
-
[](https://badge.fury.io/py/mcp-code-indexer)
|
|
4
|
+
[](https://pypi.org/project/mcp-code-indexer/)
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
6
|
|
|
7
7
|
A production-ready **Model Context Protocol (MCP) server** that revolutionizes how AI agents navigate and understand codebases. Built for high-concurrency environments with advanced database resilience, the server provides instant access to intelligent descriptions, semantic search, and context-aware recommendations while maintaining 800+ writes/sec throughput.
|
|
@@ -37,6 +37,43 @@ mcp-code-indexer
|
|
|
37
37
|
# See API Reference for complete tool documentation
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
+
### 🌐 For Web Applications
|
|
41
|
+
|
|
42
|
+
Enable HTTP/REST API access for browser-based applications:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Start HTTP server with authentication
|
|
46
|
+
mcp-code-indexer --http --auth-token "your-secret-token"
|
|
47
|
+
|
|
48
|
+
# Custom host and port
|
|
49
|
+
mcp-code-indexer --http --host 0.0.0.0 --port 8080
|
|
50
|
+
|
|
51
|
+
# CORS configuration for web apps
|
|
52
|
+
mcp-code-indexer --http --cors-origins "https://localhost:3000" "https://myapp.com"
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**🔗 [Complete HTTP API Reference →](docs/http-api.md)**
|
|
56
|
+
|
|
57
|
+
### 🤖 For AI-Powered Q&A
|
|
58
|
+
|
|
59
|
+
Ask questions about your codebase using natural language:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Set OpenRouter API key for Claude access
|
|
63
|
+
export OPENROUTER_API_KEY="your-openrouter-api-key"
|
|
64
|
+
|
|
65
|
+
# Simple questions about project architecture
|
|
66
|
+
mcp-code-indexer --ask "What does this project do?" my-project
|
|
67
|
+
|
|
68
|
+
# Enhanced analysis with file search
|
|
69
|
+
mcp-code-indexer --deepask "How is authentication implemented?" web-app
|
|
70
|
+
|
|
71
|
+
# JSON output for programmatic use
|
|
72
|
+
mcp-code-indexer --ask "List the main components" my-project --json
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**🤖 [Complete Q&A Interface Guide →](docs/qa-interface.md)**
|
|
76
|
+
|
|
40
77
|
### 🔧 For System Administrators
|
|
41
78
|
|
|
42
79
|
Deploy and configure the server for your team:
|
|
@@ -266,12 +303,16 @@ Comprehensive documentation organized by user journey and expertise level.
|
|
|
266
303
|
| Guide | Purpose | Time Investment |
|
|
267
304
|
|-------|---------|-----------------|
|
|
268
305
|
| **[Quick Start](#-quick-start)** | Install and run your first server | 2 minutes |
|
|
269
|
-
| **[Git Hook Setup](docs/git-hook-setup.md)** | Automate your workflow | 5 minutes |
|
|
270
306
|
| **[API Reference](docs/api-reference.md)** | Master all 11 MCP tools | 15 minutes |
|
|
307
|
+
| **[HTTP API Reference](docs/http-api.md)** | REST API for web applications | 10 minutes |
|
|
308
|
+
| **[Q&A Interface](docs/qa-interface.md)** | AI-powered codebase analysis | 8 minutes |
|
|
309
|
+
| **[Git Hook Setup](docs/git-hook-setup.md)** | Automate your workflow | 5 minutes |
|
|
271
310
|
|
|
272
311
|
### 🏗️ Production Deployment (Teams & Admins)
|
|
273
312
|
| Guide | Focus | Best For |
|
|
274
313
|
|-------|-------|----------|
|
|
314
|
+
| **[CLI Reference](docs/cli-reference.md)** | Complete command documentation | All users |
|
|
315
|
+
| **[Administrative Commands](docs/admin-commands.md)** | Project & database management | System administrators |
|
|
275
316
|
| **[Configuration Guide](docs/configuration.md)** | Production setup & tuning | System administrators |
|
|
276
317
|
| **[Performance Tuning](docs/performance-tuning.md)** | High-concurrency optimization | DevOps teams |
|
|
277
318
|
| **[Monitoring & Diagnostics](docs/monitoring.md)** | Production monitoring | Operations teams |
|
|
@@ -289,8 +330,10 @@ Comprehensive documentation organized by user journey and expertise level.
|
|
|
289
330
|
- **[API Tools Summary](#🛠️-mcp-tools-available)** - All 11 tools at a glance
|
|
290
331
|
|
|
291
332
|
**📚 Reading Paths:**
|
|
292
|
-
- **New to MCP Code Indexer?** Quick Start →
|
|
293
|
-
- **
|
|
333
|
+
- **New to MCP Code Indexer?** Quick Start → API Reference → HTTP API → Q&A Interface
|
|
334
|
+
- **Web developers?** Quick Start → HTTP API Reference → Q&A Interface → Git Hooks
|
|
335
|
+
- **AI/ML engineers?** Quick Start → Q&A Interface → API Reference → Git Hooks
|
|
336
|
+
- **Setting up for a team?** CLI Reference → Configuration → Administrative Commands → Monitoring
|
|
294
337
|
- **Contributing to the project?** Architecture → Contributing → API Reference
|
|
295
338
|
|
|
296
339
|
## 🚦 System Requirements
|
|
@@ -475,7 +518,31 @@ mcp-code-indexer --githook [OPTIONS]
|
|
|
475
518
|
# Requires: OPENROUTER_API_KEY environment variable
|
|
476
519
|
```
|
|
477
520
|
|
|
478
|
-
###
|
|
521
|
+
### HTTP Server Mode
|
|
522
|
+
```bash
|
|
523
|
+
# Start HTTP/REST API server
|
|
524
|
+
mcp-code-indexer --http [OPTIONS]
|
|
525
|
+
|
|
526
|
+
# HTTP server with authentication
|
|
527
|
+
mcp-code-indexer --http --auth-token "your-secret-token"
|
|
528
|
+
|
|
529
|
+
# Custom host and port configuration
|
|
530
|
+
mcp-code-indexer --http --host 0.0.0.0 --port 8080
|
|
531
|
+
```
|
|
532
|
+
|
|
533
|
+
### Q&A Commands
|
|
534
|
+
```bash
|
|
535
|
+
# Simple AI-powered questions (requires OPENROUTER_API_KEY)
|
|
536
|
+
mcp-code-indexer --ask "What does this project do?" PROJECT_NAME
|
|
537
|
+
|
|
538
|
+
# Enhanced analysis with file search
|
|
539
|
+
mcp-code-indexer --deepask "How is authentication implemented?" PROJECT_NAME
|
|
540
|
+
|
|
541
|
+
# JSON output for programmatic use
|
|
542
|
+
mcp-code-indexer --ask "Question" PROJECT_NAME --json
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
### Administrative Commands
|
|
479
546
|
```bash
|
|
480
547
|
# List all projects
|
|
481
548
|
mcp-code-indexer --getprojects
|
|
@@ -485,6 +552,12 @@ mcp-code-indexer --runcommand '{"method": "tools/call", "params": {...}}'
|
|
|
485
552
|
|
|
486
553
|
# Export descriptions for a project
|
|
487
554
|
mcp-code-indexer --dumpdescriptions PROJECT_ID
|
|
555
|
+
|
|
556
|
+
# Create local database for a project
|
|
557
|
+
mcp-code-indexer --makelocal /path/to/project
|
|
558
|
+
|
|
559
|
+
# Generate project documentation map
|
|
560
|
+
mcp-code-indexer --map PROJECT_NAME
|
|
488
561
|
```
|
|
489
562
|
|
|
490
563
|
## 🛡️ Security Features
|
|
@@ -503,8 +576,10 @@ mcp-code-indexer --dumpdescriptions PROJECT_ID
|
|
|
503
576
|
|-------|-----------|------------|
|
|
504
577
|
| **"No module named 'mcp_code_indexer'"** | `pip install -e .` (for development) | [Contributing Guide](docs/contributing.md#development-setup) |
|
|
505
578
|
| **"OPENROUTER_API_KEY not found"** | `export OPENROUTER_API_KEY="your-key"` | [Git Hook Setup](docs/git-hook-setup.md#prerequisites) |
|
|
506
|
-
| **"Database is locked"** | Enable WAL mode: `--enable-wal-mode` | [
|
|
579
|
+
| **"Database is locked"** | Enable WAL mode: `--enable-wal-mode` | [CLI Reference](docs/cli-reference.md#database-configuration) |
|
|
507
580
|
| **"Large codebase - use search"** | Normal for 200+ files. Use `search_descriptions` | [API Reference](docs/api-reference.md#search_descriptions) |
|
|
581
|
+
| **HTTP authentication failed** | Check `--auth-token` configuration | [HTTP API Reference](docs/http-api.md#authentication) |
|
|
582
|
+
| **Q&A commands not working** | Set `OPENROUTER_API_KEY` environment variable | [Q&A Interface](docs/qa-interface.md#getting-started) |
|
|
508
583
|
| **High memory usage** | Reduce token limit: `--token-limit 10000` | [Configuration Guide](docs/configuration.md#performance-tuning) |
|
|
509
584
|
|
|
510
585
|
**💡 Not finding your issue?** Check the [complete troubleshooting guides](docs/monitoring.md#troubleshooting-runbook) in our documentation.
|
|
@@ -517,13 +592,17 @@ Ready to supercharge your AI agents with intelligent codebase navigation?
|
|
|
517
592
|
|
|
518
593
|
**🆕 New to MCP Code Indexer?**
|
|
519
594
|
1. **[Install and run your first server](#-quick-start)** - Get up and running in 2 minutes
|
|
520
|
-
2. **[
|
|
521
|
-
3. **[
|
|
595
|
+
2. **[Master the API tools](docs/api-reference.md)** - Learn all 11 tools with examples
|
|
596
|
+
3. **[Try HTTP API access](docs/http-api.md)** - REST API for web applications
|
|
597
|
+
4. **[Explore AI-powered Q&A](docs/qa-interface.md)** - Ask questions about your code
|
|
598
|
+
5. **[Set up git hooks](docs/git-hook-setup.md)** - Automate your workflow
|
|
522
599
|
|
|
523
600
|
**👥 Setting up for a team?**
|
|
524
|
-
1. **[
|
|
525
|
-
2. **[
|
|
526
|
-
3. **[
|
|
601
|
+
1. **[Learn all CLI commands](docs/cli-reference.md)** - Complete command reference
|
|
602
|
+
2. **[Configure for production](docs/configuration.md)** - Production deployment guide
|
|
603
|
+
3. **[Set up administrative workflows](docs/admin-commands.md)** - Project & database management
|
|
604
|
+
4. **[Performance optimization](docs/performance-tuning.md)** - High-concurrency setup
|
|
605
|
+
5. **[Monitoring & alerts](docs/monitoring.md)** - Production monitoring
|
|
527
606
|
|
|
528
607
|
**🔧 Want to contribute?**
|
|
529
608
|
1. **[Understand the architecture](docs/architecture.md)** - Technical deep dive
|
|
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
|
|
|
4
4
|
|
|
5
5
|
[tool.poetry]
|
|
6
6
|
name = "mcp-code-indexer"
|
|
7
|
-
version = "
|
|
7
|
+
version = "4.0.1"
|
|
8
8
|
description = "MCP server that tracks file descriptions across codebases, enabling AI agents to efficiently navigate and understand code through searchable summaries and token-aware overviews."
|
|
9
9
|
authors = ["MCP Code Indexer Contributors"]
|
|
10
10
|
maintainers = ["MCP Code Indexer Contributors"]
|
|
@@ -1039,7 +1039,19 @@ class MCPCodeIndexServer:
|
|
|
1039
1039
|
|
|
1040
1040
|
total_tokens = descriptions_tokens + overview_tokens
|
|
1041
1041
|
is_large = total_tokens > token_limit
|
|
1042
|
-
|
|
1042
|
+
|
|
1043
|
+
# Smart recommendation logic:
|
|
1044
|
+
# - If total is small, use overview
|
|
1045
|
+
# - If total is large but overview is reasonable (< 8k tokens), recommend viewing overview + search
|
|
1046
|
+
# - If both are large, use search only
|
|
1047
|
+
overview_size_limit = 32000
|
|
1048
|
+
|
|
1049
|
+
if not is_large:
|
|
1050
|
+
recommendation = "use_overview"
|
|
1051
|
+
elif overview_tokens > 0 and overview_tokens <= overview_size_limit:
|
|
1052
|
+
recommendation = "view_overview_then_search"
|
|
1053
|
+
else:
|
|
1054
|
+
recommendation = "use_search"
|
|
1043
1055
|
|
|
1044
1056
|
logger.info(
|
|
1045
1057
|
f"Codebase analysis complete: {total_tokens} tokens total "
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/claude_api_handler.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/commands/makelocal.py
RENAMED
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/data/stop_words_english.txt
RENAMED
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/connection_health.py
RENAMED
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/database_factory.py
RENAMED
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/exceptions.py
RENAMED
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/path_resolver.py
RENAMED
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/database/retry_executor.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/middleware/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/middleware/logging.py
RENAMED
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/middleware/security.py
RENAMED
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/migrations/001_initial.sql
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/query_preprocessor.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/transport/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/transport/http_transport.py
RENAMED
|
File without changes
|
{mcp_code_indexer-3.6.0 → mcp_code_indexer-4.0.1}/src/mcp_code_indexer/transport/stdio_transport.py
RENAMED
|
File without changes
|