Scaffold

1. プロジェクトディレクトリを準備する

プロジェクト設定用の新しいフォルダーを作成します。

mkdir my-scaffold-server
cd my-scaffold-server

2. 設定ファイルを作成する

my-scaffold-serverディレクトリに、次の2つのファイルを作成します。

docker-compose.yaml:

services:
  scaffold-mcp:
    image: ghcr.io/beer-bears/scaffold:latest
    container_name: scaffold-mcp-prod
    env_file:
      - .env
    tty: true
    ports:
      - "8000:8080"
    depends_on:
      - neo4j
    volumes:
      - ./codebase:/app/codebase

  chromadb:
    image: chromadb/chroma:1.0.13
    container_name: scaffold-chromadb
    restart: unless-stopped
    volumes:
      - chroma_data:/data

  neo4j:
    image: neo4j:5
    container_name: scaffold-neo4j
    restart: unless-stopped
    environment:
      NEO4J_AUTH: "${NEO4J_USER:-neo4j}/${NEO4J_PASSWORD:-password}"
    volumes:
      - neo4j_data:/data
    ports:
      - "7474:7474"
      - "7687:7687"

volumes:
  chroma_data:
  neo4j_data:

.env:

# ChromaDB Settings
CHROMA_SERVER_HOST=chromadb
CHROMA_SERVER_PORT=8000
CHROMA_COLLECTION_NAME=scaffold_data

# Neo4j Credentials
NEO4J_USER=neo4j
NEO4J_PASSWORD=password
NEO4J_URI=bolt://neo4j:password@neo4j:7687

# Absolute path to your codebase
PROJECT_PATH=<ABSOLUTE_PATH_TO_YOUR_CODEBASE>

3. アプリケーションを実行する

Docker Compose を使用して、すべてのサービスを起動します。

docker-compose up -d

Scaffold が起動し、コードベースのコードの分析を開始します。

1. プロジェクトをセットアップする

まず、リポジトリをクローンし、プロジェクトディレクトリに移動します。

git clone https://github.com/Beer-Bears/scaffold.git
cd scaffold

次に、用意されているサンプルから環境ファイルを作成します。

cp .env.example .env

2. コードベースを追加する

分析する Python プロジェクトを codebase ディレクトリに配置します。

# Create the directory if it doesn't exist
mkdir -p codebase

# Copy your project files into it
cp -r /path/to/your/python/project/* ./codebase/

または、.env ファイルを編集し、PROJECT_PATH 変数にホストマシン上のプロジェクトの絶対パスを設定できます。

3. アプリケーションを実行する

Docker Compose を使用して、アプリケーションスタック全体を起動します。--build フラグを指定すると、ローカルのソースコードから新しい Docker イメージがビルドされます。

docker-compose up --build -d

ユースケース図

インターフェース図

RAG（検索拡張生成）は、次の方法で大規模言語モデル（LLM）を強化する技術です。

1. 外部のナレッジソースから関連情報を取得します
2. 取得した情報でLLMのコンテキストを拡張します
3. より正確で、コンテキストを踏まえた応答を生成します

学習データのみに依存する従来のLLMとは異なり、RAGシステムは最新のプロジェクト固有の情報にアクセスし、実際のコードベースのコンテキストに基づいて応答することで、ハルシネーションを減らします。

Graph RAGは、知識をグラフデータベース内の相互に関連するエンティティとして表現することで、従来のRAGを拡張します。これにより、システムはテキストの断片だけでなく、それらの構造的な関係（例：この関数が別の関数をcallsする、このクラスが別のクラスをinherits fromする）も理解して取得できます。この構造的なコンテキストは、複雑なソフトウェアエンジニアリングタスクにおいて非常に役立ちます。