# cocoindex - 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: `cocoindex-io/cocoindex`
- capability: Incremental engine for long horizon agents 🌟 Star if you like it!
- expected_user_outcome: Incremental engine for long horizon agents 🌟 Star if you like it!

## 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 Core Concepts**: importance `high`
  - source_paths: README.md, docs/src/content/docs/programming_guide/core_concepts.mdx, docs/src/content/docs/programming_guide/sdk_overview.mdx, docs/src/content/docs/programming_guide/app.mdx, docs/src/content/docs/programming_guide/function.mdx
- **Architecture and Engine Internals**: importance `high`
  - source_paths: rust/core/src/lib.rs, rust/core/src/engine/app.rs, rust/core/src/engine/component.rs, rust/core/src/engine/context.rs, rust/core/src/engine/execution.rs
- **Connectors, Sources, and Targets**: importance `high`
  - source_paths: python/cocoindex/connectorkits/target.py, python/cocoindex/connectorkits/statediff.py, python/cocoindex/connectorkits/fingerprint.py, python/cocoindex/connectorkits/async_adapters.py, python/cocoindex/connectors/localfs/_source.py
- **Operations, Live Mode, and Advanced Topics**: importance `high`
  - source_paths: python/cocoindex/cli.py, docs/src/content/docs/cli.mdx, docs/src/content/docs/cli_commands.mdx, docs/src/content/docs/programming_guide/live_mode.mdx, docs/src/content/docs/programming_guide/target_state.mdx

## Repo Inspection Evidence

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `ff6912c3590160a7a2167ce448b5c9c2a8230fbe`
- inspected_files: `README.md`, `pyproject.toml`, `uv.lock`, `docs/package-lock.json`, `docs/package.json`, `docs/src/components/diagrams/README.md`, `docs/src/consts.ts`, `docs/src/content/docs/about/community.mdx`, `docs/src/content/docs/about/telemetry.mdx`, `docs/src/content/docs/advanced_topics/concurrency_control.mdx`, `docs/src/content/docs/advanced_topics/custom_target_connector.mdx`, `docs/src/content/docs/advanced_topics/exception_handlers.mdx`, `docs/src/content/docs/advanced_topics/internal_storage.mdx`, `docs/src/content/docs/advanced_topics/live_component.mdx`, `docs/src/content/docs/advanced_topics/memoization_keys.mdx`, `docs/src/content/docs/advanced_topics/multiple_environments.mdx`, `docs/src/content/docs/advanced_topics/progress_monitoring.mdx`, `docs/src/content/docs/cli.mdx`, `docs/src/content/docs/cli_commands.mdx`, `docs/src/content/docs/common_resources/data_types.mdx`

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: 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/cocoindex-io/cocoindex
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

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

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

### Constraint 5: 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/cocoindex-io/cocoindex
- 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: release_recency=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/cocoindex-io/cocoindex
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.
