# kotaemon - 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: `Cinnamon/kotaemon` - capability: An open-source RAG-based tool for chatting with your documents. - expected_user_outcome: An open-source RAG-based tool for chatting with your documents. ## 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 System Architecture**: importance `high` - source_paths: README.md, app.py, flowsettings.py, libs/kotaemon/README.md, libs/kotaemon/kotaemon/base/component.py - **RAG Pipeline, LLMs, and Reasoning**: importance `high` - source_paths: libs/kotaemon/kotaemon/llms/__init__.py, libs/kotaemon/kotaemon/llms/chats/openai.py, libs/kotaemon/kotaemon/llms/chats/endpoint_based.py, libs/kotaemon/kotaemon/llms/chats/langchain_based.py, libs/kotaemon/kotaemon/llms/chats/llamacpp.py - **Document Loading, Parsing, and Indexing**: importance `high` - source_paths: libs/kotaemon/kotaemon/loaders/__init__.py, libs/kotaemon/kotaemon/loaders/pdf_loader.py, libs/kotaemon/kotaemon/loaders/docling_loader.py, libs/kotaemon/kotaemon/loaders/paddleocr_loader/__init__.py, libs/kotaemon/kotaemon/loaders/paddleocr_loader/ppstructure_v3_loader.py - **Deployment, Configuration, and Extensibility**: importance `high` - source_paths: Dockerfile, launch.sh, app.py, sso_app.py, sso_app_demo.py ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `9ad3e4e49aa35b8acddd235918a5d9753c1cfdf9` - inspected_files: `Dockerfile`, `README.md`, `pyproject.toml`, `uv.lock`, `docs/about.md`, `docs/development/contributing.md`, `docs/development/create-a-component.md`, `docs/development/data-components.md`, `docs/development/index.md`, `docs/development/utilities.md`, `docs/index.md`, `docs/integrations/docling.md`, `docs/integrations/paddle_ocr.md`, `docs/local_model.md`, `docs/online_install.md`, `docs/pages/app/customize-flows.md`, `docs/pages/app/ext/user-management.md`, `docs/pages/app/features.md`, `docs/pages/app/functional-description.md`, `docs/pages/app/index/file.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/Cinnamon/kotaemon/issues/833 - 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/Cinnamon/kotaemon/issues/834 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 3: 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: identity.distribution | https://github.com/Cinnamon/kotaemon - 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/Cinnamon/kotaemon/issues/839 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 5: 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/Cinnamon/kotaemon/issues/821 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 6: 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/Cinnamon/kotaemon - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 7: 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/Cinnamon/kotaemon - 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: 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/Cinnamon/kotaemon - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 9: 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/Cinnamon/kotaemon - 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: 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/Cinnamon/kotaemon/issues/841 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.