# neo4j-graphrag-python - 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: `neo4j/neo4j-graphrag-python` - capability: Neo4j GraphRAG for Python - expected_user_outcome: Neo4j GraphRAG for Python ## 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, Installation & Configuration**: importance `high` - source_paths: README.md, pyproject.toml, src/neo4j_graphrag/__init__.py, src/neo4j_graphrag/indexes.py, src/neo4j_graphrag/types.py - **Retrievers and Database Search**: importance `high` - source_paths: src/neo4j_graphrag/retrievers/base.py, src/neo4j_graphrag/retrievers/vector.py, src/neo4j_graphrag/retrievers/hybrid.py, src/neo4j_graphrag/retrievers/text2cypher.py, src/neo4j_graphrag/retrievers/tools_retriever.py - **Knowledge Graph Construction Pipeline**: importance `high` - source_paths: src/neo4j_graphrag/experimental/pipeline/kg_builder.py, src/neo4j_graphrag/experimental/pipeline/pipeline.py, src/neo4j_graphrag/experimental/pipeline/orchestrator.py, src/neo4j_graphrag/experimental/pipeline/component.py, src/neo4j_graphrag/experimental/pipeline/pipeline_graph.py - **Generation, LLM Providers, Embeddings & Message History**: importance `high` - source_paths: src/neo4j_graphrag/generation/graphrag.py, src/neo4j_graphrag/generation/prompts.py, src/neo4j_graphrag/generation/types.py, src/neo4j_graphrag/llm/base.py, src/neo4j_graphrag/llm/openai_llm.py ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `49b2694ad276e1f037cf7c27db3a659ea9c892cb` - inspected_files: `README.md`, `pyproject.toml`, `uv.lock`, `docs/README.md`, `docs/source/conf.py`, `docs/source/themes/neo4j/static/js/12-fragment-jumper.js`, `examples/README.md`, `examples/build_graph/automatic_schema_extraction/simple_kg_builder_schema_from_pdf.py`, `examples/build_graph/automatic_schema_extraction/simple_kg_builder_schema_from_text.py`, `examples/build_graph/from_config_files/simple_kg_pipeline_config.json`, `examples/build_graph/from_config_files/simple_kg_pipeline_config.yaml`, `examples/build_graph/from_config_files/simple_kg_pipeline_config_url.json`, `examples/build_graph/from_config_files/simple_kg_pipeline_from_config_file.py`, `examples/build_graph/from_config_files/simple_kg_pipeline_from_config_file_with_url.py`, `examples/build_graph/simple_kg_builder_from_pdf.py`, `examples/build_graph/simple_kg_builder_from_text.py`, `examples/customize/answer/custom_prompt.py`, `examples/customize/answer/langchain_compatiblity.py`, `examples/customize/build_graph/components/chunk_reader/neo4j_chunk_reader.py`, `examples/customize/build_graph/components/custom_component.py` 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/neo4j/neo4j-graphrag-python/issues/406 - 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/neo4j/neo4j-graphrag-python/issues/493 - 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/neo4j/neo4j-graphrag-python/issues/542 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 4: Identity risk requires verification - Trigger: Project evidence flags a identity 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/neo4j/neo4j-graphrag-python - 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/neo4j/neo4j-graphrag-python/issues/430 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 6: 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/neo4j/neo4j-graphrag-python/issues/439 - 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/neo4j/neo4j-graphrag-python - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it. ### Constraint 8: Runtime risk requires verification - Trigger: Project evidence flags a runtime 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/neo4j/neo4j-graphrag-python/issues/446 - 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/neo4j/neo4j-graphrag-python - 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/neo4j/neo4j-graphrag-python - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.