flow-frame-core 0.1.0 → 0.1.7

package/README.md

@@ -43,6 +43,38 @@ Detailed documentation is available in the `docs/` folder:
 -   **[Email Automation](docs/email_automation.md)**: Gmail polling and filtering.
 -   **[Workflows](docs/workflows.md)**: How to build and run workflows.
 
+## 🔧 Tool Reference (for Agent Integration)
+
+`flow-frame-core` is designed to be used as a tool library by AI agents. The complete tool glossary is in **[TOOLS.md](./TOOLS.md)**, covering every function and REST endpoint organized by capability:
+
+| Category | Tools | Integration |
+|----------|-------|-------------|
+| **LLM / AI** | `runPrompt`, `runPromptGrok`, `runImagePromptGrok` | Import or `POST /api/prompts/chat` |
+| **Prompt Chains** | `executeChain` — serial/parallel steps with auto-repair | Import |
+| **Workflow Engine** | `executeFlow` — 25+ node types in a DAG | Import or REST |
+| **JSON Utilities** | `extractJSON`, `cleanJSONString`, `containsJSON` | Import |
+| **Schema & Code Gen** | `inferSchema`, `generateJsTransformFromPrompt` | Import |
+| **Prompt Optimization** | `runAutoPromptSearch` — iterative prompt refinement | Import |
+| **Image Analysis** | `classifyImageQuery`, `findImageInImage` | Import or REST |
+| **Audio / TTS** | `processAudio` — ElevenLabs TTS | Import or `POST /generateAudio` |
+| **PDF Processing** | `extractPdf` — text, images, page renders | Import or `GET /pdf/extract` |
+| **Email** | `extractGmailBodyText`, polling endpoints | Import or REST |
+| **Web Scraping** | `crawl` — full-site depth-first crawl | Import or `POST /scrape` |
+| **Storage** | `getItem`, `setItem`, profile management | Import or REST |
+| **Queue** | `queueManager` — serial job queue with events | Import or REST |
+| **File System** | 30+ file utilities (read, write, download, zip) | Import or REST |
+| **Templates** | `generateTextFromTemplate` — LLM variable generation | Import or REST |
+| **Browser / Desktop** | Chrome control, mouse, keyboard, app management | Import or REST |
+| **Screenshots** | `captureScreenshotBase64`, `captureFullScreenshot` | Import or REST |
+| **Self-Learning Vision** | Ingest, recognize, discover screens, transition graphs | Import or REST |
+| **UI Planning** | `UiPlanner`, `StepByStepAiPlanner` — NL → automation steps | Import |
+| **Workflows CRUD** | Create, load, save, validate `.workflow` files | REST |
+| **Extensions** | Plugin discovery and execution via `api.json` | Import or REST |
+| **Media** | Video/audio dimensions, YOLO training data | Import or REST |
+| **Config** | File-based config CRUD with backup/validation | REST |
+
+See **[TOOLS.md](./TOOLS.md)** for full function signatures, parameters, return types, and REST endpoint details.
+
 ## 🌟 Key Features
 
 -   **Agentic UI Planning**: Deeply integrated AI that maps web pages and uses `robotjs` to simulate human clicks and typing.