# AdalFlow - 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: `SylphAI-Inc/AdalFlow` - capability: AdalFlow: The library to build & auto-optimize LLM applications. - expected_user_outcome: AdalFlow: The library to build & auto-optimize LLM applications. ## 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 & Core Architecture**: importance `high` - source_paths: README.md, adalflow/adalflow/core/component.py, adalflow/adalflow/core/base_data_class.py, adalflow/adalflow/core/generator.py, adalflow/adalflow/core/types.py - **Agent, Runner & Model Integration**: importance `high` - source_paths: adalflow/adalflow/components/agent/agent.py, adalflow/adalflow/components/agent/runner.py, adalflow/adalflow/components/agent/react.py, adalflow/adalflow/components/agent/prompts.py, adalflow/adalflow/core/func_tool.py - **Auto-Optimization & Training**: importance `high` - source_paths: adalflow/adalflow/optim/parameter.py, adalflow/adalflow/optim/optimizer.py, adalflow/adalflow/optim/gradient.py, adalflow/adalflow/optim/text_grad/tgd_optimizer.py, adalflow/adalflow/optim/text_grad/ops.py - **Retrieval, Tracing & Evaluation**: importance `high` - source_paths: adalflow/adalflow/components/retriever/bm25_retriever.py, adalflow/adalflow/components/retriever/faiss_retriever.py, adalflow/adalflow/components/retriever/lancedb_retriver.py, adalflow/adalflow/components/retriever/postgres_retriever.py, adalflow/adalflow/components/retriever/qdrant_retriever.py ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `810de99d86191b3aa0c939aa6d6d1a21977555aa` - inspected_files: `README.md`, `pyproject.toml`, `docs/CHANGLOG.md`, `docs/README.md`, `docs/_dummy/dummy/__init__.py`, `docs/design/ComponentTool.md`, `docs/design/FunctionTool.md`, `docs/design/README.md`, `docs/design/agent-streaming.md`, `docs/design/api_approval_examples.md`, `docs/design/intuitive_evolution_api.md`, `docs/design/tool_approval.md`, `docs/design/tool_approval_design.md`, `docs/pyproject.toml`, `docs/source/change_api_file_name.py`, `docs/source/conf.py`, `docs/source/design/ComponentTool.md`, `docs/source/design/FunctionTool.md`, `docs/source/design/README.md`, `docs/source/design/agent-streaming.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: 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/SylphAI-Inc/AdalFlow/issues/489 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 2: 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/SylphAI-Inc/AdalFlow/issues/481 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 3: 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/SylphAI-Inc/AdalFlow/issues/474 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 4: 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/SylphAI-Inc/AdalFlow/issues/479 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 5: 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/SylphAI-Inc/AdalFlow - 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: 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/SylphAI-Inc/AdalFlow - 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: 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/SylphAI-Inc/AdalFlow - 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: risks.scoring_risks | https://github.com/SylphAI-Inc/AdalFlow - 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: 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/SylphAI-Inc/AdalFlow/issues/475 - 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: 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/SylphAI-Inc/AdalFlow - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.