# nano-graphrag - 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: `gusye1234/nano-graphrag` - capability: A simple, easy-to-hack GraphRAG implementation - expected_user_outcome: A simple, easy-to-hack GraphRAG implementation ## 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. - **Project Overview & System Architecture**: importance `high` - source_paths: readme.md, nano_graphrag/__init__.py, nano_graphrag/graphrag.py, nano_graphrag/base.py, nano_graphrag/_op.py - **Configuration, Query Modes & Prompt Customization**: importance `high` - source_paths: nano_graphrag/graphrag.py, nano_graphrag/prompt.py, nano_graphrag/_llm.py, nano_graphrag/_utils.py, examples/using_custom_chunking_method.py - **Storage Backends, LLM & Embedding Integrations**: importance `high` - source_paths: nano_graphrag/base.py, nano_graphrag/_storage/__init__.py, nano_graphrag/_storage/kv_json.py, nano_graphrag/_storage/vdb_nanovectordb.py, nano_graphrag/_storage/vdb_hnswlib.py - **Benchmarks, Roadmap & Known Limitations**: importance `medium` - source_paths: docs/benchmark-en.md, docs/benchmark-zh.md, docs/benchmark-dspy-entity-extraction.md, docs/ROADMAP.md, docs/FAQ.md ## Repo Inspection Evidence - repo_clone_verified: true - repo_inspection_verified: true - repo_commit: `acb35c065614eb5a2f5f1be9a56b235f5a2e0a7a` - inspected_files: `readme.md`, `requirements.txt`, `docs/CONTRIBUTING.md`, `docs/FAQ.md`, `docs/ROADMAP.md`, `docs/benchmark-dspy-entity-extraction.md`, `docs/benchmark-en.md`, `docs/benchmark-zh.md`, `docs/use_neo4j_for_graphrag.md`, `examples/benchmarks/dspy_entity.py`, `examples/benchmarks/hnsw_vs_nano_vector_storage.py`, `examples/benchmarks/md5_vs_xxhash.py`, `examples/graphml_visualize.py`, `examples/no_openai_key_at_all.py`, `examples/using_amazon_bedrock.py`, `examples/using_custom_chunking_method.py`, `examples/using_deepseek_api_as_llm+glm_api_as_embedding.py`, `examples/using_deepseek_as_llm.py`, `examples/using_dspy_entity_extraction.py`, `examples/using_faiss_as_vextorDB.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: 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/gusye1234/nano-graphrag/issues/75 - 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/gusye1234/nano-graphrag/issues/163 - 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: community_evidence:github | https://github.com/gusye1234/nano-graphrag/issues/166 - 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: capability.host_targets | https://github.com/gusye1234/nano-graphrag - 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: community_evidence:github | https://github.com/gusye1234/nano-graphrag/issues/167 - 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/gusye1234/nano-graphrag - 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/gusye1234/nano-graphrag - 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/gusye1234/nano-graphrag - 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/gusye1234/nano-graphrag - 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/gusye1234/nano-graphrag/issues/125 - Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.