Skip to main content

MCP Codebase Insight Server

Project description

MCP Codebase Insight

MCP Codebase Insight is a server component of the Model Context Protocol (MCP) that provides intelligent analysis and insights into codebases. It uses vector search and machine learning to understand code patterns, architectural decisions, and documentation.

Target Audience

MCP Codebase Insight is designed primarily for:

  • Software Developers: Who want AI-assisted code analysis and improvements
  • Software Architects: Managing architecture decisions and technical documentation
  • DevOps Engineers: Monitoring system health and integrating with CI/CD pipelines
  • Technical Leads: Ensuring best practices and maintaining knowledge management
  • Data Scientists: Who can leverage the system for code pattern analysis

This tool is most valuable for teams working on complex codebases that require consistent patterns, architectural oversight, and thorough documentation.

Features

  • Code Analysis: Identify patterns, vulnerabilities, and optimization opportunities
  • ADR Management: Track architectural decisions with context
  • Documentation: Auto-generate and maintain technical documentation
  • Knowledge Base: Store reusable code patterns and solutions
  • Debug System: Analyze and fix issues with context awareness
  • Build Verification: Automated end-to-end build verification

How It Works

MCP Codebase Insight operates through a pipeline of intelligent analysis:

  1. Code Ingestion: The system analyzes your codebase, parsing files and understanding their structure.
  2. Embedding Generation: Code, documentation, and architectural decisions are converted into vector embeddings.
  3. Vector Storage: These embeddings are stored in a Qdrant vector database, enabling semantic search and relationship mapping.
  4. Contextual Analysis: When queried, the system retrieves relevant context from the vector database and applies specialized models to generate insights.
  5. Action Generation: Based on analysis, the system can recommend actions, generate documentation, or provide debugging assistance.

System Architecture

Note: The above URL is a placeholder for an architecture diagram. Replace with an actual diagram path.

Quick Start

For detailed installation and usage instructions, please refer to our documentation.

Important Requirement: MCP Codebase Insight requires a running Qdrant vector database instance to function properly. See Qdrant Setup for installation instructions.

Basic Installation

# Install the package
pip install mcp-codebase-insight

# Set up basic environment variables
export MCP_HOST=127.0.0.1
export MCP_PORT=3000
export QDRANT_URL=http://localhost:6333
export MCP_DOCS_CACHE_DIR=./docs
export MCP_ADR_DIR=./docs/adrs
export MCP_KB_STORAGE_DIR=./knowledge
export MCP_DISK_CACHE_DIR=./cache

# Start the server
mcp-codebase-insight --host 127.0.0.1 --port 3000 --log-level INFO

Note: For a complete list of environment variables and configuration options, see the Configuration Guide.

Using Docker

docker run -p 3000:3000 \
    --env-file .env \
    -v $(pwd)/docs:/app/docs \
    -v $(pwd)/knowledge:/app/knowledge \
    tosin2013/mcp-codebase-insight

Documentation

For complete documentation, please see the docs directory:

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_codebase_insight-0.2.1.tar.gz (55.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_codebase_insight-0.2.1-py3-none-any.whl (58.2 kB view details)

Uploaded Python 3

File details

Details for the file mcp_codebase_insight-0.2.1.tar.gz.

File metadata

  • Download URL: mcp_codebase_insight-0.2.1.tar.gz
  • Upload date:
  • Size: 55.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for mcp_codebase_insight-0.2.1.tar.gz
Algorithm Hash digest
SHA256 5b211ea3ba06b760a3a9e3008ccd7a5f6d2dd22be0804244584181ff9e8751cb
MD5 31982c7b2439748a5a760eae56af5313
BLAKE2b-256 51353482f65f014222aa0b254a7311ec570993438acbc3e57e87ad4f1deaecb4

See more details on using hashes here.

File details

Details for the file mcp_codebase_insight-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mcp_codebase_insight-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c5292773328c98cd13feef0cefa4c255c0f1c97dbb1e9f084df5ed14aad3f771
MD5 f9802fa0b945feeee63b0fafabc2aef2
BLAKE2b-256 ac876feb5422d48f124bc19cfd88d825705e9479b942ddefc25311b2c53bb53e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page