MCP Codebase Insight

# MCP Codebase Insight Documentation Welcome to the MCP Codebase Insight documentation. This directory contains detailed information about installation, configuration, usage, and development of the MCP Codebase Insight tool. ## Documentation Structure ### Getting Started - [Installation Guide](getting-started/installation.md) - Complete installation instructions - [Configuration Guide](getting-started/configuration.md) - Configuration options and environment setup - [Quick Start Tutorial](getting-started/quickstart.md) - Get up and running quickly - [Qdrant Setup](getting-started/qdrant_setup.md) - Vector database setup and configuration ### Core Features - [Code Analysis](features/code-analysis.md) - Understanding code patterns and insights - [ADR Management](features/adr-management.md) - Managing architectural decisions - [Documentation Management](features/documentation.md) - Auto-generation and maintenance - [Knowledge Base](features/knowledge-base.md) - Pattern storage and retrieval - [Debug System](features/debug-system.md) - Intelligent debugging assistance - [Build Verification](features/build-verification.md) - Automated build checks ### API Reference - [REST API](api/rest-api.md) - Complete API endpoint documentation - [SSE Integration](SSE_INTEGRATION.md) - Server-Sent Events integration guide - [Vector Store API](api/vector-store-api.md) - Vector database interaction - [Client Libraries](api/client-libraries.md) - Available client SDKs ### Development - [Contributing Guide](development/contributing.md) - How to contribute to the project - [Architecture Overview](development/architecture.md) - System architecture and design - [Testing Guide](testing_guide.md) - Writing and running tests - [Best Practices](development/best-practices.md) - Coding standards and guidelines ### Deployment - [Production Deployment](deployment/production.md) - Production setup guide - [Docker Deployment](deployment/docker.md) - Container-based deployment - [Scaling Guide](deployment/scaling.md) - Handling increased load - [Monitoring](deployment/monitoring.md) - System monitoring and alerts ### Troubleshooting - [Common Issues](troubleshooting/common-issues.md) - Frequently encountered problems - [FAQ](troubleshooting/faq.md) - Frequently asked questions - [Debug Guide](troubleshooting/debug-guide.md) - Advanced debugging techniques - [Support](troubleshooting/support.md) - Getting help and support ## Quick Links - [GitHub Repository](https://github.com/modelcontextprotocol/mcp-codebase-insight) - [Issue Tracker](https://github.com/modelcontextprotocol/mcp-codebase-insight/issues) - [Discussions](https://github.com/modelcontextprotocol/mcp-codebase-insight/discussions) - [Release Notes](CHANGELOG.md) - [License](../LICENSE) ## Contributing to Documentation We welcome contributions to improve this documentation. Please see our [Contributing Guide](development/contributing.md) for details on: - Documentation style guide - How to submit documentation changes - Documentation testing - Building documentation locally ## Documentation Versions This documentation corresponds to the latest stable release of MCP Codebase Insight. For other versions: - [Latest Development](https://github.com/modelcontextprotocol/mcp-codebase-insight/tree/main/docs) - [Version History](https://github.com/modelcontextprotocol/mcp-codebase-insight/releases) ## Support If you need help or have questions: 1. Check the [FAQ](troubleshooting/faq.md) and [Common Issues](troubleshooting/common-issues.md) 2. Search existing [GitHub Issues](https://github.com/modelcontextprotocol/mcp-codebase-insight/issues) 3. Join our [Discussion Forum](https://github.com/modelcontextprotocol/mcp-codebase-insight/discussions) 4. Open a new issue if needed