blockflow-mcp 0.0.0-stage → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,25 @@
1
+ # BlockFlow
2
+
3
+ > Playwright-compatible automation in your browser. A browser extension (Chrome/Brave/Edge, Firefox)
4
+ > for end-to-end tests, form filling, scraping and monitoring, built from connected blocks in an editor
5
+ > or written as JSON scripts (a list of steps) that users import. Import checks every file strictly and
6
+ > names each problem with a code and a JSON path, so a model can repair its own script.
7
+
8
+ To generate or explain workflows, read in this order:
9
+
10
+ - [Usage guide](docs/guide/README.md): start with "Rules for AI tools" and "Script format (write this)". Write the script format: a list of steps, compiled to blocks on import
11
+ - [Block reference](docs/guide/blocks.md): every block type, its config keys, defaults and outputs (generated from the code)
12
+ - [Block reference, JSON](docs/guide/blocks.json)
13
+ - [Script JSON Schema](docs/guide/script.schema.json): the format to write (unknown keys are errors)
14
+ - [Workflow JSON Schema](docs/guide/workflow.schema.json): the graph format the editor exports
15
+ - [Repair table](docs/guide/README.md#repair-what-import-errors-mean): import refuses a broken file and lists each problem as `<level> <code> at <JSON path>: <message> <hint>`; fix every path it names and answer with the whole corrected file
16
+ - [Example workflows](docs/guide/examples/): each as a script (`*.script.json`) and a graph (`*.blockflow.json`), checked by tests
17
+ - To run and repair workflows yourself in the user's browser: the MCP server `blockflow-mcp` (tools `snapshot_page`, `validate_workflow`, `run_workflow`, `get_report`…; needs Settings → Allow outside control and `npx blockflow-bridge install`), see [MCP Server](docs/wiki/MCP-Server.md). In CI: the `blockflow` CLI, see [CLI](docs/wiki/CLI.md)
18
+ - Element locators: prefer `role=button[name="Sign in"]`, `label=Email`, `text=…`, `testid=…` over CSS (guide section 4)
19
+
20
+ To change BlockFlow's code:
21
+
22
+ - [CLAUDE.md](CLAUDE.md): commands and codebase rules
23
+ - [Architecture](docs/ARCHITECTURE.md)
24
+ - [Internals wiki](docs/wiki/Home.md): file-by-file reference of the code
25
+ - [Plan](docs/PLAN.md) and [implementation plan and status](docs/IMPLEMENTATION.md)