# ragapp - Doramagic AI Context Pack > 定位：安装前体验与判断资产。它帮助宿主 AI 有一个好的开始，但不代表已经安装、执行或验证目标项目。 ## 充分原则 - **充分原则，不是压缩原则**：AI Context Pack 应该充分到让宿主 AI 在开工前理解项目价值、能力边界、使用入口、风险和证据来源；它可以分层组织，但不以最短摘要为目标。 - **压缩策略**：只压缩噪声和重复内容，不压缩会影响判断和开工质量的上下文。 ## 给宿主 AI 的使用方式 你正在读取 Doramagic 为 ragapp 编译的 AI Context Pack。请把它当作开工前上下文：帮助用户理解适合谁、能做什么、如何开始、哪些必须安装后验证、风险在哪里。不要声称你已经安装、运行或执行了目标项目。 ## Claim 消费规则 - **事实来源**：Repo Evidence + Claim/Evidence Graph；Human Wiki 只提供显著性、术语和叙事结构。 - **事实最低状态**：`supported` - `supported`：可以作为项目事实使用，但回答中必须引用 claim_id 和证据路径。 - `weak`：只能作为低置信度线索，必须要求用户继续核实。 - `inferred`：只能用于风险提示或待确认问题，不能包装成项目事实。 - `unverified`：不得作为事实使用，应明确说证据不足。 - `contradicted`：必须展示冲突来源，不得替用户强行选择一个版本。 ## 它最适合谁 - **正在使用 Claude/Codex/Cursor/Gemini 等宿主 AI 的开发者**：README 或插件配置提到多个宿主 AI。 证据：`README.md` Claim：`clm_0002` supported 0.86 ## 它能做什么 - **命令行启动或安装流程**（需要安装后验证）：项目文档中存在可执行命令，真实使用需要在本地或宿主环境中运行这些命令。 证据：`deployments/single/scripts/create_qdrant_collection.sh`, `deployments/single/scripts/setup_ollama.sh` Claim：`clm_0001` unverified 0.25 ## 怎么开始 - `curl -X PUT "$QDRANT_URL/collections/$collection_name" \` 证据：`deployments/single/scripts/create_qdrant_collection.sh` Claim：`clm_0003` unverified 0.25 - `curl -X POST ${OLLAMA_BASE_URL}/api/pull -d '{` 证据：`deployments/single/scripts/setup_ollama.sh` Claim：`clm_0004` unverified 0.25 ## 继续前判断卡 - **当前建议**：仅建议沙盒试装 - **为什么**：项目存在安装命令、宿主配置或本地写入线索，不建议直接进入主力环境，应先在隔离环境试装。 ### 30 秒判断 - **现在怎么做**：仅建议沙盒试装 - **最小安全下一步**：先跑 Prompt Preview；若仍要安装，只在隔离环境试装 - **先别相信**：真实输出质量不能在安装前相信。 - **继续会触碰**：命令执行、本地环境或项目文件、宿主 AI 上下文 ### 现在可以相信 - **适合人群线索：正在使用 Claude/Codex/Cursor/Gemini 等宿主 AI 的开发者**（supported）：有 supported claim 或项目证据支撑，但仍不等于真实安装效果。 证据：`README.md` Claim：`clm_0002` supported 0.86 ### 现在还不能相信 - **真实输出质量不能在安装前相信。**（unverified）：Prompt Preview 只能展示引导方式，不能证明真实项目中的结果质量。 - **宿主 AI 版本兼容性不能在安装前相信。**（unverified）：Claude、Cursor、Codex、Gemini 等宿主加载规则和版本差异必须在真实环境验证。 - **不会污染现有宿主 AI 行为，不能直接相信。**（inferred）：Skill、plugin、AGENTS/CLAUDE/GEMINI 指令可能改变宿主 AI 的默认行为。 - **可安全回滚不能默认相信。**（unverified）：除非项目明确提供卸载和恢复说明，否则必须先在隔离环境验证。 - **真实安装后是否与用户当前宿主 AI 版本兼容？**（unverified）：兼容性只能通过实际宿主环境验证。 - **项目输出质量是否满足用户具体任务？**（unverified）：安装前预览只能展示流程和边界，不能替代真实评测。 - **安装命令是否需要网络、权限或全局写入？**（unverified）：这影响企业环境和个人环境的安装风险。 证据：`deployments/single/scripts/create_qdrant_collection.sh` ### 继续会触碰什么 - **命令执行**：包管理器、网络下载、本地插件目录、项目配置或用户主目录。 原因：运行第一条命令就可能产生环境改动；必须先判断是否值得跑。 证据：`deployments/single/scripts/create_qdrant_collection.sh`, `deployments/single/scripts/setup_ollama.sh` - **本地环境或项目文件**：安装结果、插件缓存、项目配置或本地依赖目录。 原因：安装前无法证明写入范围和回滚方式，需要隔离验证。 证据：`deployments/single/scripts/create_qdrant_collection.sh`, `deployments/single/scripts/setup_ollama.sh` - **宿主 AI 上下文**：AI Context Pack、Prompt Preview、Skill 路由、风险规则和项目事实。 原因：导入上下文会影响宿主 AI 后续判断，必须避免把未验证项包装成事实。 ### 最小安全下一步 - **先跑 Prompt Preview**：用安装前交互式试用判断工作方式是否匹配，不需要授权或改环境。（适用：任何项目都适用，尤其是输出质量未知时。） - **只在隔离目录或测试账号试装**：避免安装命令污染主力宿主 AI、真实项目或用户主目录。（适用：存在命令执行、插件配置或本地写入线索时。） - **安装后只验证一个最小任务**：先验证加载、兼容、输出质量和回滚，再决定是否深用。（适用：准备从试用进入真实工作流时。） ### 退出方式 - **保留安装前状态**：记录原始宿主配置和项目状态，后续才能判断是否可恢复。 - **记录安装命令和写入路径**：没有明确卸载说明时，至少要知道哪些目录或配置需要手动清理。 - **如果没有回滚路径，不进入主力环境**：不可回滚是继续前阻断项，不应靠信任或运气继续。 ## 哪些只能预览 - 解释项目适合谁和能做什么 - 基于项目文档演示典型对话流程 - 帮助用户判断是否值得安装或继续研究 ## 哪些必须安装后验证 - 真实安装 Skill、插件或 CLI - 执行脚本、修改本地文件或访问外部服务 - 验证真实输出质量、性能和兼容性 ## 边界与风险判断卡 - **把安装前预览误认为真实运行**：用户可能高估项目已经完成的配置、权限和兼容性验证。 处理方式：明确区分 prompt_preview_can_do 与 runtime_required。 Claim：`clm_0005` inferred 0.45 - **命令执行会修改本地环境**：安装命令可能写入用户主目录、宿主插件目录或项目配置。 处理方式：先在隔离环境或测试账号中运行。 证据：`deployments/single/scripts/create_qdrant_collection.sh`, `deployments/single/scripts/setup_ollama.sh` Claim：`clm_0006` inferred 0.45 - **待确认**：真实安装后是否与用户当前宿主 AI 版本兼容？。原因：兼容性只能通过实际宿主环境验证。 - **待确认**：项目输出质量是否满足用户具体任务？。原因：安装前预览只能展示流程和边界，不能替代真实评测。 - **待确认**：安装命令是否需要网络、权限或全局写入？。原因：这影响企业环境和个人环境的安装风险。 ## 开工前工作上下文 ### 加载顺序 - 先读取 how_to_use.host_ai_instruction，建立安装前判断资产的边界。 - 读取 claim_graph_summary，确认事实来自 Claim/Evidence Graph，而不是 Human Wiki 叙事。 - 再读取 intended_users、capabilities 和 quick_start_candidates，判断用户是否匹配。 - 需要执行具体任务时，优先查 role_skill_index，再查 evidence_index。 - 遇到真实安装、文件修改、网络访问、性能或兼容性问题时，转入 risk_card 和 boundaries.runtime_required。 ### 任务路由 - **命令行启动或安装流程**：先说明这是安装后验证能力，再给出安装前检查清单。 边界：必须真实安装或运行后验证。 证据：`deployments/single/scripts/create_qdrant_collection.sh`, `deployments/single/scripts/setup_ollama.sh` ### 上下文规模 - 文件总数：246 - 重要文件覆盖：40/246 - 证据索引条目：49 - 角色 / Skill 条目：8 ### 证据不足时的处理 - **missing_evidence**：说明证据不足，要求用户提供目标文件、README 段落或安装后验证记录；不要补全事实。 - **out_of_scope_request**：说明该任务超出当前 AI Context Pack 证据范围，并建议用户先查看 Human Manual 或真实安装后验证。 - **runtime_request**：给出安装前检查清单和命令来源，但不要替用户执行命令或声称已执行。 - **source_conflict**：同时展示冲突来源，标记为待核实，不要强行选择一个版本。 ## Prompt Recipes ### 适配判断 - 目标：判断这个项目是否适合用户当前任务。 - 预期输出：适配结论、关键理由、证据引用、安装前可预览内容、必须安装后验证内容、下一步建议。 ```text 请基于 ragapp 的 AI Context Pack，先问我 3 个必要问题，然后判断它是否适合我的任务。回答必须包含：适合谁、能做什么、不能做什么、是否值得安装、证据来自哪里。所有项目事实必须引用 evidence_refs、source_paths 或 claim_id。 ``` ### 安装前体验 - 目标：让用户在安装前感受核心工作流，同时避免把预览包装成真实能力或营销承诺。 - 预期输出：一段带边界标签的体验剧本、安装后验证清单和谨慎建议；不含真实运行承诺或强营销表述。 ```text 请把 ragapp 当作安装前体验资产，而不是已安装工具或真实运行环境。 请严格输出四段： 1. 先问我 3 个必要问题。 2. 给出一段“体验剧本”：用 [安装前可预览]、[必须安装后验证]、[证据不足] 三种标签展示它可能如何引导工作流。 3. 给出安装后验证清单：列出哪些能力只有真实安装、真实宿主加载、真实项目运行后才能确认。 4. 给出谨慎建议：只能说“值得继续研究/试装”“先补充信息后再判断”或“不建议继续”，不得替项目背书。 硬性边界： - 不要声称已经安装、运行、执行测试、修改文件或产生真实结果。 - 不要写“自动适配”“确保通过”“完美适配”“强烈建议安装”等承诺性表达。 - 如果描述安装后的工作方式，必须使用“如果安装成功且宿主正确加载 Skill，它可能会……”这种条件句。 - 体验剧本只能写成“示例台词/假设流程”：使用“可能会询问/可能会建议/可能会展示”，不要写“已写入、已生成、已通过、正在运行、正在生成”。 - Prompt Preview 不负责给安装命令；如用户准备试装，只能提示先阅读 Quick Start 和 Risk Card，并在隔离环境验证。 - 所有项目事实必须来自 supported claim、evidence_refs 或 source_paths；inferred/unverified 只能作风险或待确认项。 ``` ### 角色 / Skill 选择 - 目标：从项目里的角色或 Skill 中挑选最匹配的资产。 - 预期输出：候选角色或 Skill 列表，每项包含适用场景、证据路径、风险边界和是否需要安装后验证。 ```text 请读取 role_skill_index，根据我的目标任务推荐 3-5 个最相关的角色或 Skill。每个推荐都要说明适用场景、可能输出、风险边界和 evidence_refs。 ``` ### 风险预检 - 目标：安装或引入前识别环境、权限、规则冲突和质量风险。 - 预期输出：环境、权限、依赖、许可、宿主冲突、质量风险和未知项的检查清单。 ```text 请基于 risk_card、boundaries 和 quick_start_candidates，给我一份安装前风险预检清单。不要替我执行命令，只说明我应该检查什么、为什么检查、失败会有什么影响。 ``` ### 宿主 AI 开工指令 - 目标：把项目上下文转成一次对话开始前的宿主 AI 指令。 - 预期输出：一段边界明确、证据引用明确、适合复制给宿主 AI 的开工前指令。 ```text 请基于 ragapp 的 AI Context Pack，生成一段我可以粘贴给宿主 AI 的开工前指令。这段指令必须遵守 not_runtime=true，不能声称项目已经安装、运行或产生真实结果。 ``` ## 角色 / Skill 索引 - 共索引 8 个角色 / Skill / 项目文档条目。 - **Changesets**（project_doc）：Hello and welcome! This folder has been automatically generated by @changesets/cli , a build tool that works with multi-package repos, or single-package repos to help you version and publish your code. You can find the full documentation for it in our repository https://github.com/changesets/changesets 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`.changeset/README.md` - **Get Started**（project_doc）：The easiest way to use Agentic RAG in any enterprise. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`README.md` - **RAGApp with Manager**（project_doc）：- Manage RAGApp containers through a manager UI - Start/Stop multiple RAGApp containers - Deploy with Traefik reverse proxy and Keycloak Authentication and user management - Persistence of the RAGApps data and configuration in the file system 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`deployments/multiple-ragapps/README.md` - **Single RAGApp deployment**（project_doc）：Deploy RAGapp with Ollama https://ollama.com/ and Qdrant https://qdrant.tech/ easily in your own infrastructure. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`deployments/single/README.md` - **RAGapp agent manager**（project_doc）：RAGapp agent manager This is a manager app designed to help you manage the RAGapp agent running in Docker. 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`src/manager/README.md` - **Getting Started**（project_doc）：This is a Next.js https://nextjs.org/ project bootstrapped with create-next-app https://github.com/vercel/next.js/tree/canary/packages/create-next-app . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`src/manager/frontend/README.md` - **Getting Started**（project_doc）：This is a Next.js https://nextjs.org/ project bootstrapped with create-next-app https://github.com/vercel/next.js/tree/canary/packages/create-next-app . 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`src/ragapp/admin-ui/README.md` - **ragbox**（project_doc）：- 7b9c24e: Fix the UI crash when displaying the code block 激活提示：当用户需要理解项目结构、安装方式或边界时参考。 证据：`CHANGELOG.md` ## 证据索引 - 共索引 49 条证据。 - **Changesets**（documentation）：Hello and welcome! This folder has been automatically generated by @changesets/cli , a build tool that works with multi-package repos, or single-package repos to help you version and publish your code. You can find the full documentation for it in our repository https://github.com/changesets/changesets 证据：`.changeset/README.md` - **Get Started**（documentation）：The easiest way to use Agentic RAG in any enterprise. 证据：`README.md` - **RAGApp with Manager**（documentation）：- Manage RAGApp containers through a manager UI - Start/Stop multiple RAGApp containers - Deploy with Traefik reverse proxy and Keycloak Authentication and user management - Persistence of the RAGApps data and configuration in the file system 证据：`deployments/multiple-ragapps/README.md` - **Single RAGApp deployment**（documentation）：Deploy RAGapp with Ollama https://ollama.com/ and Qdrant https://qdrant.tech/ easily in your own infrastructure. 证据：`deployments/single/README.md` - **RAGapp agent manager**（documentation）：RAGapp agent manager This is a manager app designed to help you manage the RAGapp agent running in Docker. 证据：`src/manager/README.md` - **Getting Started**（documentation）：This is a Next.js https://nextjs.org/ project bootstrapped with create-next-app https://github.com/vercel/next.js/tree/canary/packages/create-next-app . 证据：`src/manager/frontend/README.md` - **Getting Started**（documentation）：This is a Next.js https://nextjs.org/ project bootstrapped with create-next-app https://github.com/vercel/next.js/tree/canary/packages/create-next-app . 证据：`src/ragapp/admin-ui/README.md` - **Package**（package_manifest）：{ "name": "ragbox", "version": "0.1.5", "private": true, "scripts": {}, "devDependencies": { "@changesets/cli": "^2.27.1" }, "packageManager": "pnpm@9.4.0" } 证据：`package.json` - **Package**（package_manifest）：{ "name": "ragapp-admin-dashboard", "version": "0.1.0", "private": true, "scripts": { "dev": "export ENVIRONMENT=dev && next dev", "build": "next build", "start": "next start", "lint": "eslint ' / .{ts,tsx}' --max-warnings=0", "format": "prettier --ignore-unknown --cache --check .", "format:write": "prettier --ignore-unknown --write ." }, "dependencies": { "@hookform/resolvers": "^3.9.0", "@radix-ui/react-alert-dialog": "^1.1.1", "@radix-ui/react-avatar": "^1.1.0", "@radix-ui/react-dialog": "^1.1.1", "@radix-ui/react-icons": "^1.3.0", "@radix-ui/react-label": "^2.1.0", "@radix-ui/react-slot": "^1.1.0", "@radix-ui/react-tooltip": "^1.1.2", "class-variance-authority": "^0.7.0", "clsx": "^2.1.… 证据：`src/manager/frontend/package.json` - **Package**（package_manifest）：{ "name": "ragbox-admin", "version": "0.1.0", "private": true, "scripts": { "dev": "next dev", "build": "next build", "start": "next start", "lint": "eslint ' / .{ts,tsx}' --max-warnings=0", "format": "prettier --ignore-unknown --cache --check .", "format:write": "prettier --ignore-unknown --write ." }, "dependencies": { "@hookform/resolvers": "^3.6.0", "@radix-ui/react-checkbox": "^1.0.4", "@radix-ui/react-dialog": "^1.0.5", "@radix-ui/react-label": "^2.0.2", "@radix-ui/react-select": "^2.0.0", "@radix-ui/react-slot": "^1.0.2", "@radix-ui/react-switch": "^1.1.0", "@radix-ui/react-tabs": "^1.1.0", "@radix-ui/react-toast": "^1.1.5", "@radix-ui/react-tooltip": "^1.0.7", "class-variance-author… 证据：`src/ragapp/admin-ui/package.json` - **License**（source_file）：Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ 证据：`LICENSE` - **App Config**（source_file）：CONFIG DIR = f"{settings.state dir local}/manager/config/apps" class AppConfigService ⋮---- persist dir = CONFIG DIR ⋮---- @classmethod def persist app config cls, app config: RAGAppContainerConfig ⋮---- app name = app config.name config = app config.model dump json ⋮---- @classmethod def load all configs from disk cls - list RAGAppContainerConfig ⋮---- configs = ⋮---- config = json.loads f.read ⋮---- @classmethod def delete app config cls, app name: str ⋮---- file path = os.path.join cls.persist dir, f"{app name}.json" ⋮---- @classmethod def load config from disk cls, app name: str - RAGAppContainerConfig ⋮---- @classmethod def update app status cls, app name: str, status: str ⋮---- config… 证据：`src/manager/app/services/app_config.py` - **Agent**（source_file）：import { z } from "zod"; import { CodeGeneratorToolConfig, DEFAULT CODE GENERATOR TOOL CONFIG, } from "./tools/code generator"; import { DEFAULT DOCUMENT GENERATOR TOOL CONFIG, DocumentGeneratorToolConfig, } from "./tools/document generator"; import { DEFAULT DUCKDUCKGO TOOL CONFIG, DuckDuckGoToolConfig, } from "./tools/duckduckgo"; import { DEFAULT IMAGE GENERATOR TOOL CONFIG, ImageGeneratorToolConfig, } from "./tools/image generator"; import { DEFAULT E2B INTERPRETER TOOL CONFIG, E2BInterpreterToolConfig, } from "./tools/interpreter"; import { DEFAULT OPENAPI TOOL CONFIG, OpenAPIToolConfig, } from "./tools/openapi"; import { DEFAULT QUERY ENGINE TOOL CONFIG, QueryEngineToolConfig, } from… 证据：`src/ragapp/admin-ui/client/agent.ts` - **T Systems**（source_file）：import { z } from "zod"; import { BaseConfigSchema } from "./base"; 证据：`src/ragapp/admin-ui/client/providers/t-systems.ts` - **Document Generator**（source_file）：import { z } from "zod"; ⋮---- export type DocumentGeneratorToolConfigType = z.infer ; 证据：`src/ragapp/admin-ui/client/tools/document_generator.ts` - **Wikipedia**（source_file）：import { z } from "zod"; ⋮---- export type WikipediaToolConfigType = z.infer ; 证据：`src/ragapp/admin-ui/client/tools/wikipedia.ts` - **Constants**（source_file）：ENV FILE PATH = "config/.env" TOOL CONFIG FILE = "config/tools.yaml" LOADER CONFIG FILE = "config/loaders.yaml" AGENT CONFIG FILE = "config/agents.yaml" DEFAULT SYSTEM PROMPT = SYSTEM PROMPT WITH TOOLS TPL = """ 证据：`src/ragapp/backend/constants.py` - **Agent Prompt Manager**（source_file）：class AgentPromptManager ⋮---- @staticmethod def get tool custom prompts agent: AgentConfig - str ⋮---- tool custom prompts = "" ⋮---- @classmethod def generate agent system prompt cls, agent: AgentConfig Dict - str ⋮---- agent = AgentConfig agent base prompt = agent.get system prompt tool custom prompts = cls. get tool custom prompts agent 证据：`src/ragapp/backend/controllers/agent_prompt_manager.py` - **Agents**（source_file）：logger = logging.getLogger "uvicorn" class AgentManager ⋮---- instance = None lock = threading.Lock config lock = threading.RLock def new cls def init self ⋮---- @staticmethod def load config file - Dict def ensure all tools exist self ⋮---- with self. config lock: Acquire lock for config modification updated = False ⋮---- tool cls = self.available tools tool name ⋮---- updated = True ⋮---- def update config file self def get agents self - List AgentConfig ⋮---- with self. config lock: Acquire lock for reading config agents = return sorted agents, key=lambda x: x.created at Sort by creation time def create agent self, agent data: Dict - AgentConfig ⋮---- agent id = agent data.get "agent id"… 证据：`src/ragapp/backend/controllers/agents.py` - **Loader**（source_file）：class LoaderManager ⋮---- config file: Dict def init self def update loader self, loader config: LoaderConfig def get loader self, loader name: str = None ⋮---- config = self.config.get loader name ⋮---- @staticmethod def load config file - Dict def update config file self def loader manager 证据：`src/ragapp/backend/controllers/loader.py` - **Constants**（source_file）：DEFAULT TOP K = 3 DEFAULT MAX TOP K = 20 证据：`src/ragapp/backend/engine/constants.py` - **backwards compatibility for created at field**（source_file）：DEFAULT SYSTEM PROMPT TEMPLATE = class ToolConfig BaseModel ⋮---- enabled: bool = False config: Dict = Field default factory=dict class AgentConfig BaseModel ⋮---- agent id: Optional str = None name: str role: str = Field ..., min length=1 goal: str = Field ..., min length=1 backstory: str = "" system prompt: Optional str = None tools: Dict str, ToolConfig = Field default factory=dict created at: int str = Field def init self, kwargs ⋮---- backwards compatibility for created at field preprocess created at if it's a date time string ⋮---- @classmethod def create agent id cls, name: str - str def get system prompt self - str ⋮---- system prompt = PromptTemplate self.system prompt .format ⋮---… 证据：`src/ragapp/backend/models/agent.py` - **Chat Config**（source_file）：DEFAULT NEXT QUESTION PROMPT = """You're a helpful assistant! Your task is to suggest the next question that user might ask. DEFAULT SYSTEM CITATION PROMPT = """You have provided information from a knowledge base that has been passed to you in nodes of information. class ChatConfig BaseEnvConfig ⋮---- custom prompt: str None = Field conversation starters: NewlineListEnv str None = Field next question prompt: str None = Field system citation prompt: str None = Field def init self, kwargs class Config ⋮---- extra = "ignore" json schema extra = { ⋮---- def preprocess string prompt cls, value ⋮---- @field validator "conversation starters", mode="before" def preprocess conversation starters cls,… 证据：`src/ragapp/backend/models/chat_config.py` - **Llamacloud Config**（source_file）：class LlamaCloudConfig BaseEnvConfig ⋮---- use llama cloud: bool None = Field llama cloud index name: str None = Field llama cloud project name: str None = Field llama cloud api key: str None = Field ⋮---- @classmethod def get config cls - Self 证据：`src/ragapp/backend/models/llamacloud_config.py` - **Loader**（source_file）：DEFAULT SUPPORTED FILE TYPES = ".txt", ".pdf", ".csv" class FileLoader BaseModel ⋮---- loader name: Literal "file" = Field use llama parse: bool = Field llama cloud api key: str None = Field def init self, data ⋮---- env api key = os.getenv "LLAMA CLOUD API KEY" ⋮---- def update env api key self def to config dict self def get supported file extensions self - List str LoaderConfig = Union FileLoader SupportedLoaders = Literal "file" 证据：`src/ragapp/backend/models/loader.py` - **Model Config**（source_file）：class OpenAIConfig BaseModel ⋮---- openai api key: str None = Field openai api base: str None = Field class GeminiConfig BaseModel ⋮---- google api key: str None = Field class OllamaConfig BaseModel ⋮---- ollama base url: str None = Field ollama request timeout: float None = Field class AzureOpenAIConfig BaseModel ⋮---- azure openai endpoint: str None = Field azure openai api key: str None = Field azure openai api version: str None = Field azure openai llm deployment: str None = Field azure openai embedding deployment: str None = Field class TSystemsConfig BaseModel ⋮---- t systems llmhub api key: str None = Field t systems llmhub api base: str None = Field class MistralConfig BaseModel ⋮--… 证据：`src/ragapp/backend/models/model_config.py` - **Reranker Config**（source_file）：class CohereRerankerConfig BaseEnvConfig ⋮---- use reranker: bool None = Field rerank provider: str None = Field cohere api key: str None = Field def get reranker config 证据：`src/ragapp/backend/models/reranker_config.py` - **Code Generator**（source_file）：class CodeGeneratorToolConfig BaseModel ⋮---- api key: str None = Field def init self, kwargs ⋮---- api key = kwargs.get "api key" ⋮---- class CodeGeneratorTool BaseModel ⋮---- config id: ClassVar str = "artifact" name: Literal "CodeGenerator" = "CodeGenerator" tool type: Literal "local" = "local" label: Literal "Code Generator" = "Code Generator" custom prompt: Optional config: CodeGeneratorToolConfig None = Field enabled: bool = False def validate config self - bool 证据：`src/ragapp/backend/models/tools/code_generator.py` - **Document Generator**（source_file）：class DocumentGeneratorTool BaseModel ⋮---- config id: ClassVar str = "document generator" name: Literal "DocumentGenerator" = "DocumentGenerator" tool type: Literal "local" = "local" label: Literal "Document Generator" = "Document Generator" description: str = "Generate a document file PDF, HTML " custom prompt: Optional str = dedent config: Dict = {} enabled: bool = False 证据：`src/ragapp/backend/models/tools/document_generator.py` - **Wikipedia**（source_file）：class WikipediaTool BaseModel ⋮---- config id: ClassVar str = "wikipedia.WikipediaToolSpec" name: Literal "wikipedia" = "wikipedia" tool type: Literal "llamahub" = "llamahub" label: Literal "Wikipedia" = "Wikipedia" description: str = custom prompt: Optional str = None config: Dict = {} enabled: bool = False 证据：`src/ragapp/backend/models/tools/wikipedia.py` - **Agents**（source_file）：agents router = r = APIRouter logger = logging.getLogger "uvicorn" ⋮---- model provider = os.environ.get "MODEL PROVIDER" ⋮---- model = os.environ.get "MODEL" ⋮---- """ Get all configured agents. """ ⋮---- @r.get "/multi agent supported" def multi agent supported - bool ⋮---- llm = Settings.llm ⋮---- """ Create a new agent. """ 证据：`src/ragapp/backend/routers/management/agents.py` - **Config**（source_file）：config router = r = APIRouter ⋮---- updated config = ChatConfig.get config ⋮---- config = ModelConfig.get config 证据：`src/ragapp/backend/routers/management/config.py` - **Loader**（source_file）：loader router = r = APIRouter logger = logging.getLogger "uvicorn" ⋮---- """ Get the current loader configuration. """ ⋮---- loader = loader manager.get loader loader name ⋮---- """ Update the loader configuration. """ 证据：`src/ragapp/backend/routers/management/loader.py` - **The orchestrator uses "role" to select the right agent for a task**（source_file）：def get tool tool name: str, config: dict, query engine=None ⋮---- description = f"{config.description or ''}\nThis is a preferred tool to use" ⋮---- tool config = config.config ⋮---- tool config = tool config.dict tools = ToolFactory.load tools config.tool type, config.config id, tool config ⋮---- agent manager = AgentManager agents config = agent manager.get agents agents = ⋮---- agent tools config = agent manager.get agent tools agent config.agent id tools = system prompt = agent config.get system prompt The orchestrator uses "role" to select the right agent for a task construct a "description" from the user defined role and goal for better orchestration description = f"{agent config.rol… 证据：`src/ragapp/backend/workflows/orchestrator.py` - **get chat history**（source_file）：class InputEvent Event ⋮---- input: list ChatMessage class ToolCallEvent Event ⋮---- tool calls: list ToolSelection class AgentRunEvent Event ⋮---- name: str msg: str ⋮---- @property def msg self ⋮---- @msg.setter def msg self, value class AgentRunResult BaseModel ⋮---- response: ChatResponse sources: list ToolOutput class ContextAwareTool FunctionTool ⋮---- @abstractmethod async def acall self, ctx: Context, input: Any - ToolOutput class FunctionCallingAgent Workflow ⋮---- llm = Settings.llm ⋮---- @step async def prepare chat history self, ctx: Context, ev: StartEvent - InputEvent ⋮---- system msg = ChatMessage role="system", content=self.system prompt ⋮---- user input = ev.input user msg… 证据：`src/ragapp/backend/workflows/single.py` - **ragbox**（documentation）：- 7b9c24e: Fix the UI crash when displaying the code block 证据：`CHANGELOG.md` - **Test Index Config**（source_file）：def create test app ⋮---- app = FastAPI ⋮---- test app = create test app client = TestClient test app ⋮---- @pytest.mark.usefixtures "mock env" def test get index llamacloud enabled ⋮---- index = get index ⋮---- @pytest.mark.usefixtures "mock env" def test get index llamacloud disabled ⋮---- @pytest.mark.usefixtures "mock env" def test update llamacloud config changes get index ⋮---- new config = { response = client.put "/api/management/llamacloud", json=new config ⋮---- response = client.put "/api/management/llamacloud", json={} 证据：`src/ragapp/backend/tests/test_index_config.py` - **Config**（structured_config）：{ "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json", "changelog": "@changesets/cli/changelog", "commit": false, "fixed": , "linked": , "access": "restricted", "baseBranch": "main", "updateInternalDependencies": "patch", "ignore": } 证据：`.changeset/config.json` - **.Eslintrc**（structured_config）：{ "extends": "next/core-web-vitals", "prettier" , "rules": { "max-params": "error", 4 , "prefer-const": "error" } } 证据：`src/manager/frontend/.eslintrc.json` - **.Prettierrc**（structured_config）：{ "plugins": "prettier-plugin-organize-imports" } 证据：`src/manager/frontend/.prettierrc.json` - **Components**（structured_config）：{ "$schema": "https://ui.shadcn.com/schema.json", "style": "default", "rsc": true, "tsx": true, "tailwind": { "config": "tailwind.config.ts", "css": "src/app/globals.css", "baseColor": "gray", "cssVariables": true }, "aliases": { "utils": "@/lib/utils", "components": "@/components" } } 证据：`src/manager/frontend/components.json` - **Tsconfig**（structured_config）：{ "compilerOptions": { "lib": "dom", "dom.iterable", "esnext" , "allowJs": true, "skipLibCheck": true, "strict": true, "noEmit": true, "esModuleInterop": true, "module": "esnext", "moduleResolution": "bundler", "resolveJsonModule": true, "isolatedModules": true, "jsx": "preserve", "incremental": true, "plugins": { "name": "next" } , "paths": { "@/ ": "./src/ " } }, "include": "next-env.d.ts", " / .ts", " / .tsx", ".next/types/ / .ts" , "exclude": "node modules" } 证据：`src/manager/frontend/tsconfig.json` - **.Eslintrc**（structured_config）：{ "extends": "next/core-web-vitals", "prettier" , "rules": { "max-params": "error", 4 , "prefer-const": "error" } } 证据：`src/ragapp/admin-ui/.eslintrc.json` - **.Prettierrc**（structured_config）：{ "plugins": "prettier-plugin-organize-imports" } 证据：`src/ragapp/admin-ui/.prettierrc.json` - **Components**（structured_config）：{ "$schema": "https://ui.shadcn.com/schema.json", "style": "default", "rsc": false, "tsx": true, "tailwind": { "config": "tailwind.config.ts", "css": "styles/globals.css", "baseColor": "slate", "cssVariables": true, "prefix": "" }, "aliases": { "components": "@/components", "utils": "@/lib/utils" } } 证据：`src/ragapp/admin-ui/components.json` - **Tsconfig**（structured_config）：{ "compilerOptions": { "lib": "dom", "dom.iterable", "esnext" , "allowJs": true, "skipLibCheck": true, "strict": true, "noEmit": true, "esModuleInterop": true, "module": "esnext", "moduleResolution": "bundler", "resolveJsonModule": true, "isolatedModules": true, "jsx": "preserve", "incremental": true, "paths": { "@/ ": "./ " } }, "include": "next-env.d.ts", " / .ts", " / .tsx" , "exclude": "node modules" } 证据：`src/ragapp/admin-ui/tsconfig.json` - **deployments**（source_file）：/ pycache / /.env /.mypy cache/ /node modules/ /static/ 证据：`.gitignore` - **Central Makefile at the root of the repository**（source_file）：Central Makefile at the root of the repository 证据：`Makefile` - **deployments/.gitignore**（source_file）：! /.env 证据：`deployments/.gitignore` ## 宿主 AI 必须遵守的规则 - **把本资产当作开工前上下文，而不是运行环境。**：AI Context Pack 只包含证据化项目理解，不包含目标项目的可执行状态。 证据：`.changeset/README.md`, `README.md`, `deployments/multiple-ragapps/README.md` - **回答用户时区分可预览内容与必须安装后才能验证的内容。**：安装前体验的消费者价值来自降低误装和误判，而不是伪装成真实运行。 证据：`.changeset/README.md`, `README.md`, `deployments/multiple-ragapps/README.md` ## 用户开工前应该回答的问题 - 你准备在哪个宿主 AI 或本地环境中使用它？ - 你只是想先体验工作流，还是准备真实安装？ - 你最在意的是安装成本、输出质量、还是和现有规则的冲突？ ## 验收标准 - 所有能力声明都能回指到 evidence_refs 中的文件路径。 - AI_CONTEXT_PACK.md 没有把预览包装成真实运行。 - 用户能在 3 分钟内看懂适合谁、能做什么、如何开始和风险边界。 --- ## Doramagic Context Augmentation 下面内容用于强化 Repomix/AI Context Pack 主体。Human Manual 只提供阅读骨架；踩坑日志会被转成宿主 AI 必须遵守的工作约束。 ## Human Manual 骨架 使用规则：这里只是项目阅读路线和显著性信号，不是事实权威。具体事实仍必须回到 repo evidence / Claim Graph。 宿主 AI 硬性规则： - 不得把页标题、章节顺序、摘要或 importance 当作项目事实证据。 - 解释 Human Manual 骨架时，必须明确说它只是阅读路线/显著性信号。 - 能力、安装、兼容性、运行状态和风险判断必须引用 repo evidence、source path 或 Claim Graph。 - **Overview & System Architecture**：importance `high` - source_paths: README.md, src/ragapp/main.py, src/manager/main.py, src/ragapp/backend/engine/engine.py, src/ragapp/backend/workflows/orchestrator.py - **Agent Configuration, Tools & LLM Providers**：importance `high` - source_paths: src/ragapp/backend/controllers/agents.py, src/ragapp/backend/models/agent.py, src/ragapp/backend/models/tools/__init__.py, src/ragapp/backend/models/tools/query_engine.py, src/ragapp/backend/models/tools/code_generator.py - **Knowledge Management, Vector Stores & Retrieval**：importance `high` - source_paths: src/ragapp/backend/controllers/files.py, src/ragapp/backend/controllers/loader.py, src/ragapp/backend/models/loader.py, src/ragapp/backend/models/file.py, src/ragapp/backend/models/llamacloud_config.py - **Deployment, Manager UI & Operations**：importance `high` - source_paths: deployments/single/docker-compose.yml, deployments/single/README.md, deployments/single/scripts/setup_ollama.sh, deployments/single/scripts/create_qdrant_collection.sh, deployments/multiple-ragapps/docker-compose.yml ## Repo Inspection Evidence / 源码检查证据 - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `f7f88892a92c110853dfa019f2c4a605a4a7b6f5` - inspected_files: `README.md`, `package.json`, `pnpm-lock.yaml`, `examples/openapi/hackernews.yaml`, `src/manager/README.md`, `src/manager/app/__init__.py`, `src/manager/app/docker_client.py`, `src/manager/app/models/docker_service.py`, `src/manager/app/models/ragapp.py`, `src/manager/app/models/volume.py`, `src/manager/app/routers/services.py`, `src/manager/app/services/__init__.py`, `src/manager/app/services/app.py`, `src/manager/app/services/app_config.py`, `src/manager/app/services/app_data.py`, `src/manager/app/services/container.py`, `src/manager/app/settings.py`, `src/manager/app/tasks/__init__.py`, `src/manager/app/tasks/init_apps.py`, `src/manager/app/utils.py` 宿主 AI 硬性规则： - 没有 repo_clone_verified=true 时，不得声称已经读过源码。 - 没有 repo_inspection_verified=true 时，不得把 README/docs/package 文件判断写成事实。 - 没有 quick_start_verified=true 时，不得声称 Quick Start 已跑通。 ## Doramagic Pitfall Constraints / 踩坑约束 这些规则来自 Doramagic 发现、验证或编译过程中的项目专属坑点。宿主 AI 必须把它们当作工作约束，而不是普通说明文字。 ### Constraint 1: 依赖 Docker 环境 - Trigger: 安装/运行入口包含 Docker 命令：docker run -p 8000:8000 ragapp/ragapp - Host AI rule: 标注 Docker 前置条件，并提供非 Docker 路径或失败提示。 - Why it matters: 非工程用户可能没有 Docker，启动成本明显增加。 - Evidence: identity.distribution | https://github.com/ragapp/ragapp | docker run -p 8000:8000 ragapp/ragapp - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 2: 来源证据：Add governance and audit trails for enterprise RAG deployments - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：Add governance and audit trails for enterprise RAG deployments - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/ragapp/ragapp/issues/289 | 来源讨论提到 python 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 3: 来源证据：Question / suggestion: use WFGY 16-problem map as an optional RAG failure debugger - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：Question / suggestion: use WFGY 16-problem map as an optional RAG failure debugger - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/ragapp/ragapp/issues/287 | 来源讨论提到 python 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 4: 来源证据：Response always empty - Trigger: GitHub 社区证据显示该项目存在一个安装相关的待验证问题：Response always empty - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/ragapp/ragapp/issues/271 | 来源讨论提到 docker 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 5: 能力判断依赖假设 - Trigger: README/documentation is current enough for a first validation pass. - Host AI rule: 将假设转成下游验证清单。 - Why it matters: 假设不成立时，用户拿不到承诺的能力。 - Evidence: capability.assumptions | https://github.com/ragapp/ragapp | README/documentation is current enough for a first validation pass. - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 6: 来源证据：Add 'BaseURL' for OpenAI provider - Trigger: GitHub 社区证据显示该项目存在一个维护/版本相关的待验证问题：Add 'BaseURL' for OpenAI provider - Host AI rule: 来源显示可能已有修复、规避或版本变化，说明书中必须标注适用版本。 - Why it matters: 可能增加新用户试用和生产接入成本。 - Evidence: community_evidence:github | https://github.com/ragapp/ragapp/issues/283 | 来源类型 github_issue 暴露的待验证使用条件。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 7: 维护活跃度未知 - Trigger: 未记录 last_activity_observed。 - Host AI rule: 补 GitHub 最近 commit、release、issue/PR 响应信号。 - Why it matters: 新项目、停更项目和活跃项目会被混在一起，推荐信任度下降。 - Evidence: evidence.maintainer_signals | https://github.com/ragapp/ragapp | last_activity_observed missing - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 - Trigger: no_demo - Evidence: downstream_validation.risk_items | https://github.com/ragapp/ragapp | no_demo; severity=medium - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 9: 存在评分风险 - Trigger: no_demo - Why it matters: 风险会影响是否适合普通用户安装。 - Evidence: risks.scoring_risks | https://github.com/ragapp/ragapp | no_demo; severity=medium - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。 ### Constraint 10: 来源证据：Add OpenRouter adapter for LLM - Trigger: GitHub 社区证据显示该项目存在一个安全/权限相关的待验证问题：Add OpenRouter adapter for LLM - Why it matters: 可能影响授权、密钥配置或安全边界。 - Evidence: community_evidence:github | https://github.com/ragapp/ragapp/issues/282 | 来源讨论提到 api key 相关条件，需在安装/试用前复核。 - Hard boundary: 不要把这个坑点包装成已解决、已验证或可忽略，除非后续验证证据明确证明它已经关闭。