# PocketFlow - 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: `The-Pocket/PocketFlow`
- capability: Pocket Flow: 100-line LLM framework. Let Agents build Agents!
- expected_user_outcome: Pocket Flow: 100-line LLM framework. Let Agents build Agents!

## 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.

- **Core Framework Architecture: Node, Flow, and Graph Abstraction**: importance `high`
  - source_paths: pocketflow/__init__.py, pocketflow/__init__.pyi, setup.py, docs/core_abstraction/node.md, docs/core_abstraction/flow.md
- **Design Patterns: Agent, Workflow, RAG, and Multi-Agent**: importance `high`
  - source_paths: docs/design_pattern/agent.md, docs/design_pattern/workflow.md, docs/design_pattern/rag.md, docs/design_pattern/multi_agent.md, docs/design_pattern/mapreduce.md
- **Utility Functions: LLM, Embeddings, Vector, TTS, Web Search, and Visualization**: importance `medium`
  - source_paths: docs/utility_function/llm.md, docs/utility_function/embedding.md, docs/utility_function/vector.md, docs/utility_function/text_to_speech.md, docs/utility_function/websearch.md
- **Cookbook Examples, Human-in-the-Loop, and Deployment**: importance `high`
  - source_paths: cookbook/README.md, cookbook/pocketflow-hello-world/main.py, cookbook/pocketflow-hello-world/flow.py, cookbook/pocketflow-agent/main.py, cookbook/pocketflow-rag/main.py

## Repo Inspection Evidence

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `43ef382bb0c9dae8167528618bb40f5a3f9a28a5`
- inspected_files: `README.md`, `docs/_config.yml`, `docs/core_abstraction/async.md`, `docs/core_abstraction/batch.md`, `docs/core_abstraction/communication.md`, `docs/core_abstraction/flow.md`, `docs/core_abstraction/index.md`, `docs/core_abstraction/node.md`, `docs/core_abstraction/parallel.md`, `docs/design_pattern/agent.md`, `docs/design_pattern/index.md`, `docs/design_pattern/mapreduce.md`, `docs/design_pattern/multi_agent.md`, `docs/design_pattern/rag.md`, `docs/design_pattern/structure.md`, `docs/design_pattern/workflow.md`, `docs/guide.md`, `docs/index.md`, `docs/utility_function/chunking.md`, `docs/utility_function/embedding.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/The-Pocket/PocketFlow/issues/110
- 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/The-Pocket/PocketFlow/issues/132
- 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/The-Pocket/PocketFlow/issues/30
- 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: community_evidence:github | https://github.com/The-Pocket/PocketFlow/issues/106
- 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: 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/The-Pocket/PocketFlow/issues/119
- 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/The-Pocket/PocketFlow/issues/128
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 7: 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/The-Pocket/PocketFlow/issues/139
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 8: 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/The-Pocket/PocketFlow
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 9: Capability evidence risk requires verification

- Trigger: Project evidence flags a capability evidence 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/The-Pocket/PocketFlow/issues/136
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 10: 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/The-Pocket/PocketFlow
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.
