# UltraRAG - Doramagic AI Context Pack > Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated. ## Project - canonical_name: `OpenBMB/UltraRAG` - capability: A Low-Code MCP Framework for Building Complex and Innovative RAG Pipelines - expected_user_outcome: A Low-Code MCP Framework for Building Complex and Innovative RAG Pipelines ## Operating Boundaries - Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it. - Project facts must come from repo evidence, Claim Graph, or explicit source references. - When a capability is not verified, mark it as unverified instead of completing it as fact. - publish_status: `publishable` - blocking_gaps: none --- ## Doramagic Context Augmentation The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints. ## Human Manual Outline Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph. Host AI hard rules: - Do not treat page titles, section order, summaries, or importance values as factual project evidence. - When explaining the Human Manual outline, state that it is only a reading route or salience signal. - Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph. - **Overview and Core Architecture**: importance `high` - source_paths: README.md, src/ultrarag/__init__.py, src/ultrarag/api.py, src/ultrarag/cli.py, src/ultrarag/client.py - **MCP Servers and Core Components**: importance `high` - source_paths: servers/retriever/src/retriever.py, servers/retriever/src/index_backends/base.py, servers/retriever/src/index_backends/faiss_backend.py, servers/retriever/src/index_backends/milvus_backend.py, servers/retriever/src/websearch_backends/base.py - **Pipelines, Workflows and Examples**: importance `high` - source_paths: examples/experiments/sayhello.yaml, examples/experiments/rag_full.yaml, examples/experiments/rag_loop.yaml, examples/experiments/rag_branch.yaml, examples/experiments/rag_deploy.yaml - **UI, Memory System and API Deployment**: importance `high` - source_paths: ui/backend/app.py, ui/backend/auth.py, ui/backend/chat_store.py, ui/backend/kb_visibility_store.py, ui/backend/pipeline_manager.py ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `f334fa7edfa8525fe2d58f12b38f39d19ff14db5` - inspected_files: `uv.lock`, `Dockerfile`, `pyproject.toml`, `README.md`, `docs/CODE_OF_CONDUCT.md`, `docs/debug_rag_workflows_zh.md`, `docs/CONTRIBUTING.md`, `docs/README_zh.md`, `docs/frontend_mobile_chat_baseline.md`, `docs/SECURITY.md`, `examples/experiments/load_data.yaml`, `examples/experiments/rag_deploy.yaml`, `examples/experiments/rag_loop.yaml`, `examples/experiments/vanilla_vlm.yaml`, `examples/experiments/build_text_corpus.yaml`, `examples/experiments/evisrag.yaml`, `examples/experiments/rag_branch.yaml`, `examples/experiments/eval_trec.yaml`, `examples/experiments/milvus_index.yaml`, `examples/experiments/evaluate_results.yaml` Host AI hard rules: - Without repo_clone_verified=true, do not claim that the source code has been read. - Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts. - Without quick_start_verified=true, do not claim that the Quick Start path has run successfully. ## Doramagic Pitfall Constraints These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes. ### Constraint 1: Capability evidence risk requires verification - Trigger: README/documentation is current enough for a first validation pass. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: capability.assumptions | https://github.com/OpenBMB/UltraRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 2: Maintenance risk requires verification - Trigger: Project evidence flags a maintenance risk. Review the linked source before relying on this workflow. - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: evidence.maintainer_signals | https://github.com/OpenBMB/UltraRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 3: Security or permission risk requires verification - Trigger: no_demo - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: downstream_validation.risk_items | https://github.com/OpenBMB/UltraRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 4: Security or permission risk requires verification - Trigger: no_demo - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: risks.scoring_risks | https://github.com/OpenBMB/UltraRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 5: Maintenance risk requires verification - Trigger: issue_or_pr_quality=unknown。 - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: evidence.maintainer_signals | https://github.com/OpenBMB/UltraRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 6: Maintenance risk requires verification - Trigger: release_recency=unknown。 - Host AI rule: Reproduce the official install and quickstart path in an isolated environment. - Why it matters: May increase setup, validation, or first-run risk for the user. - Evidence: evidence.maintainer_signals | https://github.com/OpenBMB/UltraRAG - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.