# R2R - 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: `SciPhi-AI/R2R` - capability: SoTA production-ready AI retrieval system. Agentic Retrieval-Augmented Generation (RAG) with a RESTful API. - expected_user_outcome: SoTA production-ready AI retrieval system. Agentic Retrieval-Augmented Generation (RAG) with a RESTful API. ## 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. - **Introduction, Installation & SDK Usage**: importance `high` - source_paths: py/README.md, py/sdk/README.md, js/sdk/README.md, js/README.md, py/r2r/serve.py - **REST API, Services & Provider Architecture**: importance `high` - source_paths: py/core/main/api/v3/base_router.py, py/core/main/api/v3/documents_router.py, py/core/main/api/v3/retrieval_router.py, py/core/main/api/v3/graph_router.py, py/core/main/api/v3/users_router.py - **Ingestion Modes, Parsers, Search & Agentic RAG**: importance `high` - source_paths: py/core/providers/ingestion/r2r/base.py, py/core/providers/ingestion/unstructured/base.py, py/core/parsers/text/html_parser.py, py/core/parsers/structured/csv_parser.py, py/core/main/orchestration/simple/ingestion_workflow.py - **Deployment, Configuration, Extensibility & Troubleshooting**: importance `high` - source_paths: docker/compose.yaml, docker/compose.full.yaml, docker/compose.full.swarm.yaml, docker/env/r2r.env, docker/env/r2r-full.env ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `9c5a94d151f90876bd7eb860f300a8fd662dc481` - inspected_files: `docs/README.md`, `docs/cookbooks/application.md`, `docs/cookbooks/custom-tools.md`, `docs/cookbooks/email.md`, `docs/cookbooks/evals.md`, `docs/cookbooks/graphs.md`, `docs/cookbooks/ingestion.md`, `docs/cookbooks/local.md`, `docs/cookbooks/logging.md`, `docs/cookbooks/maintenance.md`, `docs/cookbooks/mcp.md`, `docs/cookbooks/orchestration.md`, `docs/cookbooks/structured-output.md`, `docs/cookbooks/web-dev.md`, `docs/documentation/README.md`, `docs/documentation/advanced/contextual-enrichment.md`, `docs/documentation/advanced/deduplication.md`, `docs/documentation/general/collections.md`, `docs/documentation/general/conversations.md`, `docs/documentation/general/documents.md` 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: Installation risk requires verification - Trigger: Project evidence flags a installation 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: community_evidence:github | https://github.com/SciPhi-AI/R2R/issues/2276 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 2: Security or permission risk requires verification - Trigger: Project evidence flags a security or permission 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: community_evidence:github | https://github.com/SciPhi-AI/R2R/issues/2279 - 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: Project evidence flags a security or permission 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: community_evidence:github | https://github.com/SciPhi-AI/R2R/issues/2290 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 4: Installation risk requires verification - Trigger: Project evidence flags a installation 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: community_evidence:github | https://github.com/SciPhi-AI/R2R/issues/1820 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 5: Configuration risk requires verification - Trigger: Project evidence flags a configuration 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: capability.host_targets | https://github.com/SciPhi-AI/R2R - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 6: Configuration risk requires verification - Trigger: Project evidence flags a configuration 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: community_evidence:github | https://github.com/SciPhi-AI/R2R/issues/2293 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 7: 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/SciPhi-AI/R2R - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 8: 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: community_evidence:github | https://github.com/SciPhi-AI/R2R/issues/2289 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 9: 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/SciPhi-AI/R2R - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 10: 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/SciPhi-AI/R2R - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.