# Where to Find Official codebase-memory-mcp Documentation: Complete File Reference > Locate the complete official codebase-memory-mcp documentation within the DeusData GitHub repository. Find the main README and detailed guides in the docs directory for comprehensive insights. - Repository: [Martin Vogel/codebase-memory-mcp](https://github.com/DeusData/codebase-memory-mcp) - Tags: api-reference - Published: 2026-07-27 --- **The official codebase-memory-mcp documentation resides entirely within the DeusData/codebase-memory-mcp GitHub repository, organized across the root README.md and specialized markdown files in the docs/ directory that cover configuration, benchmarking, security, and package-specific installation guides.** The **codebase-memory-mcp** project maintains its entire documentation suite inside the repository itself, making it accessible directly through GitHub's rendered markdown interface or local clones. This approach ensures that documentation stays synchronized with the codebase and provides authoritative guidance on the Hybrid LSP architecture, graph-based queries, and the coordination daemon. Whether you are installing via curl, npm, or PyPI, the relevant instructions and configuration references are stored in specific file paths within the repository structure. ## Core Documentation Structure ### Project Overview and Quick Start (README.md) The central entry point for codebase-memory-mcp documentation is [`README.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/README.md) located in the repository root. This file contains the comprehensive project overview, installation instructions, feature explanations including Hybrid LSP and graph-based queries, and performance benchmarks. It serves as the primary resource for understanding the coordination daemon and supported languages. ### Configuration Reference (docs/CONFIGURATION.md) For detailed runtime settings and environment variables, refer to [`docs/CONFIGURATION.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/docs/CONFIGURATION.md). This file provides complete documentation of JSON/YAML config files and explains how to use the `codebase-memory-mcp config` command to manage settings. ### Performance Benchmarks (docs/BENCHMARK.md) Empirical performance data lives in [`docs/BENCHMARK.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/docs/BENCHMARK.md), which documents measured indexing times, query latencies, and memory usage across real-world codebases including the Linux kernel and Django. ### Security Policies (SECURITY.md) The [`SECURITY.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/SECURITY.md) file at the repository root contains the project's security disclosure policy, vulnerability reporting guidelines, and overall security posture. ## Specialized Documentation Files ### Ignore File Rules (docs/cbmignore.md) The [`docs/cbmignore.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/docs/cbmignore.md) file details the syntax and precedence rules for `.cbmignore` files, which work in conjunction with `.gitignore` to exclude files from the indexing process. ### Research and Evaluation (docs/EVALUATION_PLAN.md) Academic users can reference [`docs/EVALUATION_PLAN.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/docs/EVALUATION_PLAN.md) for the research evaluation plan and links to the arXiv pre-print describing the underlying technology. ### Third-Party Notices (THIRD_PARTY.md) Licensing information for bundled dependencies is maintained in [`THIRD_PARTY.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/THIRD_PARTY.md) at the repository root. ## Installation and Package Documentation ### Setup Scripts (scripts/README.md) Developer-focused installation helpers and CI scripts are documented in [`scripts/README.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/scripts/README.md), which describes platform-specific setup procedures and manual build instructions. ### Package Manager Guides Distribution-specific instructions are located in: - [`pkg/npm/README.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/pkg/npm/README.md) – npm package installation and usage - [`pkg/pypi/README.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/pkg/pypi/README.md) – PyPI package installation and usage ## Querying Documentation from the Command Line The codebase-memory-mcp CLI provides self-documenting capabilities that reference the configuration options described in the markdown files. ```bash # One-line install (macOS / Linux) – documented in README.md Quick Start curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh | bash # Install with optional UI variant curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh | bash -s -- --ui ``` ```bash # List all configuration keys – see docs/CONFIGURATION.md codebase-memory-mcp config list # Enable automatic indexing for new projects codebase-memory-mcp config set auto_index true ``` ```bash # Run structural search for functions named *Handler* – usage in README.md MCP Tools codebase-memory-mcp cli search_graph --project my-project --name-pattern '.*Handler.*' --label Function # View architecture summary for a project codebase-memory-mcp cli get_architecture --project my-project ``` ## Summary - The official codebase-memory-mcp documentation is hosted entirely within the GitHub repository at DeusData/codebase-memory-mcp - Root-level files ([`README.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/README.md), [`SECURITY.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/SECURITY.md), [`THIRD_PARTY.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/THIRD_PARTY.md)) provide overview, security, and licensing information - The `docs/` directory contains specialized references for configuration, benchmarking, ignore rules, and research evaluation - Package-specific installation instructions are located in [`pkg/npm/README.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/pkg/npm/README.md) and [`pkg/pypi/README.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/pkg/pypi/README.md) - All documentation is viewable via GitHub's web interface or local markdown readers ## Frequently Asked Questions ### Is there a separate documentation website for codebase-memory-mcp? No, the project does not maintain a separate documentation website. All official documentation is stored as markdown files within the repository itself, rendered automatically by GitHub. This ensures documentation remains version-controlled and synchronized with the source code. ### How do I access configuration options for codebase-memory-mcp? Configuration options are documented in [`docs/CONFIGURATION.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/docs/CONFIGURATION.md) and accessible via the CLI using `codebase-memory-mcp config list`. This command displays all available JSON/YAML configuration keys, environment variables, and runtime settings. ### Where can I find performance benchmarks for large codebases? Empirical performance data is located in [`docs/BENCHMARK.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/docs/BENCHMARK.md), which contains indexing times, query latencies, and memory usage statistics for large-scale projects including the Linux kernel and Django frameworks. ### How do I report security vulnerabilities for codebase-memory-mcp? Security vulnerabilities should be reported according to the guidelines in [`SECURITY.md`](https://github.com/DeusData/codebase-memory-mcp/blob/main/SECURITY.md) at the repository root. This file outlines the disclosure process, vulnerability handling procedures, and the project's security posture.