# paper-qa - 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: `Future-House/paper-qa` - capability: High accuracy RAG for answering questions from scientific documents with citations - expected_user_outcome: High accuracy RAG for answering questions from scientific documents with citations ## 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 Quickstart**: importance `high` - source_paths: README.md, src/paperqa/__init__.py, CITATION.cff, pyproject.toml - **Installation and CLI Usage**: importance `high` - source_paths: README.md, src/paperqa/agents/main.py, src/paperqa/paths.py, src/paperqa/configs/high_quality.json, src/paperqa/configs/fast.json - **System Architecture and Data Flow**: importance `high` - source_paths: src/paperqa/core.py, src/paperqa/types.py, src/paperqa/llms.py, src/paperqa/prompts.py, src/paperqa/utils.py - **Agentic Workflow and Tools**: importance `high` - source_paths: src/paperqa/agents/main.py, src/paperqa/agents/tools.py, src/paperqa/agents/env.py, src/paperqa/agents/models.py, src/paperqa/agents/search.py ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `d7675d7b7eddeb3535e8c260399c5bbeeb818c50` - inspected_files: `README.md`, `pyproject.toml`, `uv.lock`, `docs/tutorials/querying_with_clinical_trials.md`, `docs/tutorials/running_on_lfrqa.md`, `docs/tutorials/settings_tutorial.md`, `docs/tutorials/where_do_I_get_papers.md`, `packages/paper-qa-docling/README.md`, `packages/paper-qa-docling/pyproject.toml`, `packages/paper-qa-docling/src/paperqa_docling/__init__.py`, `packages/paper-qa-docling/src/paperqa_docling/reader.py`, `packages/paper-qa-docling/tests/test_paperqa_docling.py`, `packages/paper-qa-nemotron/README.md`, `packages/paper-qa-nemotron/pyproject.toml`, `packages/paper-qa-nemotron/src/paperqa_nemotron/__init__.py`, `packages/paper-qa-nemotron/src/paperqa_nemotron/api.py`, `packages/paper-qa-nemotron/src/paperqa_nemotron/reader.py`, `packages/paper-qa-nemotron/tests/cassettes/TestNvidiaAPI.test_detection_only[0].yaml`, `packages/paper-qa-nemotron/tests/cassettes/TestNvidiaAPI.test_detection_only[1].yaml`, `packages/paper-qa-nemotron/tests/cassettes/TestNvidiaAPI.test_markdown_bbox[0].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: 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/Future-House/paper-qa/issues/1330 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 2: 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/Future-House/paper-qa/issues/1310 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 3: 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/Future-House/paper-qa - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 4: 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/Future-House/paper-qa - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 5: 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/Future-House/paper-qa - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 6: 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/Future-House/paper-qa - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 7: 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/Future-House/paper-qa/issues/399 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 8: 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/Future-House/paper-qa/issues/1325 - 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: 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/Future-House/paper-qa - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 10: 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/Future-House/paper-qa - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.