Scaffold

1. 准备项目目录

为项目设置创建一个新文件夹。

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

2. 创建配置文件

在 my-scaffold-server 目录中创建以下两个文件。

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. 将检索到的信息补充到大模型的上下文中
3. 生成更准确、能结合上下文的回答

传统大模型仅依赖训练数据，而 RAG 系统能够访问最新的项目专属信息，并通过让回答以实际代码库上下文为依据来减少幻觉。

Graph RAG 通过将知识表示为图数据库中相互关联的实体，扩展了传统 RAG。这让系统不仅能理解和检索文本片段，还能理解和检索它们之间的结构关系（例如，某个函数调用另一个函数，某个类继承自另一个类）。对于复杂的软件工程任务，这种结构化上下文非常有价值。