Files-DB-MCP

by randomm
Verified

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Uses Docker volumes for persistent model caching and deployment of the vector search service

  • Monitors Git-managed projects for file changes and provides real-time search updates as code evolves

  • Supports installation and deployment from GitHub repositories, with direct integration for source code access

Files-DB-MCP: コードプロジェクトのベクトル検索

メッセージ制御プロトコル (MCP) を介して、LLM コーディング エージェントにソフトウェア プロジェクトの高速で効率的な検索機能を提供するローカル ベクター データベース システム。

特徴

  • ゼロ構成- 適切なデフォルトを使用してプロジェクト構造を自動検出します
  • リアルタイム監視- ファイルの変更を継続的に監視します
  • ベクトル検索- 関連するコードを見つけるためのセマンティック検索
  • MCP インターフェース- Claude Code およびその他の LLM ツールと互換性があります
  • オープンソースモデル- コードの埋め込みにHugging Faceモデルを使用

インストール

オプション 1: クローンとセットアップ (推奨)

# Using SSH (recommended if you have SSH keys set up with GitHub) git clone git@github.com:randomm/files-db-mcp.git ~/.files-db-mcp && bash ~/.files-db-mcp/install/setup.sh # Using HTTPS (if you don't have SSH keys set up) git clone https://github.com/randomm/files-db-mcp.git ~/.files-db-mcp && bash ~/.files-db-mcp/install/setup.sh

オプション2: 自動インストールスクリプト

curl -fsSL https://raw.githubusercontent.com/randomm/files-db-mcp/main/install/install.sh | bash

使用法

インストール後、任意のプロジェクト ディレクトリで実行します。

files-db-mcp

このサービスでは次のことが行われます。

  1. プロジェクトファイルを検出する
  2. バックグラウンドでインデックス作成を開始する
  3. MCP検索クエリにすぐに応答し始める

要件

  • ドッカー
  • Dockerコンポーズ

構成

Files-DB-MCP は設定なしで動作しますが、環境変数を使用してカスタマイズできます。

  • EMBEDDING_MODEL - 埋め込みモデルを変更します(デフォルト: 'jinaai/jina-embeddings-v2-base-code' またはプロジェクト固有のモデル)
  • FAST_STARTUP - 起動を高速化するために小さいモデルを使用するには「true」に設定します(デフォルト:「false」)
  • QUANTIZATION - 量子化を有効/無効にする(デフォルト: 'true')
  • BINARY_EMBEDDINGS - バイナリ埋め込みを有効/無効にする(デフォルト: 'false')
  • IGNORE_PATTERNS - 無視するファイル/ディレクトリのコンマ区切りリスト

初めてのスタートアップ

初回実行時に、Files-DB-MCP は埋め込みモデルをダウンロードしますが、これには次の条件に応じて数分かかる場合があります。

  • 選択したモデルのサイズ(高品質モデルの場合は300~500MB)
  • インターネット接続速度

モデルは永続的なDockerボリュームにキャッシュされるため、以降の起動は大幅に高速化されます。初期起動を高速化するには、以下の方法があります。

# Use a smaller, faster model (90MB) EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2 files-db-mcp # Or enable fast startup mode FAST_STARTUP=true files-db-mcp

モデルキャッシュ

Files-DB-MCP はダウンロードした埋め込みモデルを自動的に保存するため、ダウンロードする必要があるのは 1 回だけです。

  • モデルはmodel_cacheと呼ばれるDockerボリュームに保存されます。
  • このボリュームはコンテナの再起動や異なるプロジェクト間でも保持されます
  • キャッシュは、マシン上の Files-DB-MCP を使用するすべてのプロジェクトで共有されます。
  • プロジェクトごとにモデルを再度ダウンロードする必要はありません

クロード・コード統合

Claude Code 構成に追加:

{ "mcpServers": { "files-db-mcp": { "command": "python", "args": ["/path/to/src/claude_mcp_server.py", "--host", "localhost", "--port", "6333"] } } }

詳細については、 「Claude MCP 統合」を参照してください。

ドキュメント

リポジトリ構造

  • /src - ソースコード
  • /tests - ユニットテストと統合テスト
  • /docs - ドキュメント
  • /scripts - ユーティリティスクリプト
  • /install - インストールスクリプト
  • /.docker - Docker 設定
  • /config - 設定ファイル
  • /ai-assist - AIアシスタンスファイル

ライセンス

MITライセンス

貢献

貢献を歓迎します!お気軽にプルリクエストを送信してください。

-
security - not tested
A
license - permissive license
-
quality - not tested

メッセージ制御プロトコルを介して、ソフトウェア プロジェクトの高速で効率的なセマンティック検索機能を LLM コーディング エージェントに提供するローカル ベクター データベース システム。

  1. Features
    1. Installation
      1. Option 1: Clone and Setup (Recommended)
      2. Option 2: Automated Installation Script
    2. Usage
      1. Requirements
        1. Configuration
          1. First-Time Startup
          2. Model Caching
        2. Claude Code Integration
          1. Documentation
            1. Repository Structure
              1. License
                1. Contributing
                  ID: xedtkxqtfn