From 61664985d8a70ff14ff8efbb4e7f119a2f9c4f0e Mon Sep 17 00:00:00 2001
From: Oskar Stark <oskarstark@googlemail.com>
Date: Mon, 8 Sep 2025 23:41:33 +0200
Subject: [PATCH]  Add `AGENTS.md` with optimized guidance for AI agents

---
 AGENTS.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..c793fce
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,62 @@
+# AGENTS.md
+
+AI agent guidance for the Store component.
+
+## Component Overview
+
+Low-level abstraction for vector stores enabling RAG applications. Unified interfaces for various vector database implementations.
+
+## Architecture
+
+### Core Interfaces
+- **StoreInterface**: Main interface with `add()` and `query()` methods
+- **ManagedStoreInterface**: Extends with `setup()` and `drop()` lifecycle methods
+- **Indexer**: High-level service converting TextDocuments to VectorDocuments
+
+### Bridge Pattern
+Multiple vector store implementations:
+
+**Database**: Postgres, MariaDB, ClickHouse, MongoDB, Neo4j, SurrealDB
+**Cloud**: Azure AI Search, Pinecone
+**Search**: Meilisearch, Typesense, Weaviate, Qdrant, Milvus
+**Local**: InMemoryStore, CacheStore (PSR-6)
+**External**: ChromaDb (requires codewithkyrian/chromadb-php)
+
+### Document System
+- **TextDocument**: Input documents with text and metadata
+- **VectorDocument**: Documents with embedded vectors for storage
+- **Vectorizer**: Converts TextDocuments using AI Platform
+- **Transformers**: ChainTransformer, TextSplitTransformer, ChunkDelayTransformer
+
+## Essential Commands
+
+### Testing
+```bash
+vendor/bin/phpunit
+vendor/bin/phpunit tests/Bridge/Local/InMemoryStoreTest.php
+vendor/bin/phpunit --filter testMethodName
+```
+
+### Code Quality
+```bash
+vendor/bin/phpstan analyse
+```
+
+### Dependencies
+```bash
+composer install
+```
+
+## Key Dependencies
+
+- **symfony/ai-platform**: AI model integration and vectorization
+- **psr/log**: Logging throughout indexing process
+- **symfony/http-client**: HTTP-based vector store communication
+
+## Development Notes
+
+- Bridge pattern architecture with corresponding test structure
+- PHPUnit 11+ with strict configuration
+- Document preprocessing with transformers
+- Batch indexing for performance
+- Unified interface across all vector store types
\ No newline at end of file