@agimon-ai/browse-tool 0.2.5 → 0.2.7

package/README.md

@@ -64,6 +64,7 @@ Options:
   --port <port>          Port for streamable HTTP transport (default: "3201")
   -p, --profile <name>   Default profile name for browser sessions
   --custom-tools <path>  Expose tools from a folder containing tools.yaml
+  --snippets-dir <path>  Directory used by browser_run_code to save and load reusable snippets
 ```
 
 ### Streamable HTTP Transport
@@ -200,6 +201,13 @@ browse-tool exec-custom-tool \
 | `browser_resize_page` | Resize the browser viewport |
 | `browser_emulate` | Emulate device, geolocation, or network conditions |
 
+### Code Tools (2)
+
+| Tool | Description |
+|------|-------------|
+| `browser_run_code` | Execute inline code against `{ page, context, browser }`, optionally save it as a reusable snippet |
+| `browser_list_snippets` | List saved snippets by name, description, and snippetPath |
+
 ### Testing/Tracing Tools (3)
 
 | Tool | Description |
@@ -217,63 +225,47 @@ browse-tool exec-custom-tool \
 | `browser_delete_profile` | Delete a profile |
 | `browser_save_profile_state` | Save current browser state to profile |
 
-### Automation Tools (3)
-
-| Tool | Description |
-|------|-------------|
-| `run_automation` | Run an automation script with optional pause |
-| `resume_automation` | Resume a paused automation |
-| `get_automation_status` | Get automation session status |
-
-## Automation Script Format
-
-Automation scripts are TypeScript/JavaScript modules that export a `run` function:
-
-```typescript
-import type { AutomationFixtures } from 'browse-tool';
-
-export async function run({ page, context, browser, pauseCheck }: AutomationFixtures) {
-  // Navigate to a page
-  await page.goto('https://example.com');
-
-  // Create a pause checkpoint for LLM intervention
-  await pauseCheck('after-navigation', 'Page loaded, ready for inspection');
+## Saved Snippets
 
-  // Continue with automation
-  await page.click('#login-button');
+If you start `mcp-serve` or `http-serve` with `--snippets-dir <path>`, `browser_run_code` can persist inline snippets and later execute them again by `snippetPath`.
 
-  // Another pause point
-  await pauseCheck('after-login-click', 'Login button clicked');
+Save an inline snippet:
 
-  // Fill form
-  await page.fill('#username', 'testuser');
-  await page.fill('#password', 'password123');
+```json
+{
+  "tool": "browser_run_code",
+  "arguments": {
+    "pageId": "page-1",
+    "code": "return await page.title();",
+    "saveAs": {
+      "name": "Get Page Title",
+      "description": "Return the current page title"
+    }
+  }
 }
 ```
 
-### Fixtures Available
+List saved snippets:
 
-| Fixture | Type | Description |
-|---------|------|-------------|
-| `page` | `Page` | Playwright Page instance |
-| `context` | `BrowserContext` | Playwright BrowserContext |
-| `browser` | `Browser` | Playwright Browser instance |
-| `pauseCheck` | `Function` | Create pause checkpoints for LLM control |
-
-### Using pauseCheck
+```json
+{
+  "tool": "browser_list_snippets",
+  "arguments": {}
+}
+```
 
-The `pauseCheck` function allows the automation to pause at specific points, giving the LLM control to inspect the page, interact manually, and then resume:
+Run a saved snippet:
 
-```typescript
-await pauseCheck(stepName: string, reason?: string): Promise<void>
+```json
+{
+  "tool": "browser_run_code",
+  "arguments": {
+    "pageId": "page-1",
+    "snippetPath": "get-page-title.ts"
+  }
+}
 ```
 
-When paused:
-1. The automation waits for `resume_automation` to be called
-2. All browser tools remain available for LLM interaction
-3. The LLM can inspect page state, take screenshots, etc.
-4. Once resumed, automation continues from where it paused
-
 ## Profile Management
 
 Profiles allow you to persist browser state (cookies, localStorage, etc.) across sessions.
@@ -291,20 +283,6 @@ Profiles allow you to persist browser state (cookies, localStorage, etc.) across
 }
 ```
 
-### Use a Profile with Automation
-
-```json
-{
-  "tool": "run_automation",
-  "arguments": {
-    "scriptPath": "/path/to/script.ts",
-    "browserOptions": {
-      "profile": "my-profile"
-    }
-  }
-}
-```
-
 ### Save Profile State
 
 ```json
@@ -317,47 +295,6 @@ Profiles allow you to persist browser state (cookies, localStorage, etc.) across
 }
 ```
 
-## LLM-Controlled Automation Flow
-
-The unique feature of browse-tool is the ability to run automation scripts with LLM intervention points:
-
-1. **Start Automation with Pause**
-   ```json
-   {
-     "tool": "run_automation",
-     "arguments": {
-       "scriptPath": "/path/to/script.ts",
-       "pauseAtStart": true
-     }
-   }
-   ```
-
-2. **Automation Pauses** - Returns `automationId` and `pageIds`
-
-3. **LLM Interacts** - Use browser tools (`browser_click`, `browser_fill`, etc.) on the paused pages
-
-4. **Resume Automation**
-   ```json
-   {
-     "tool": "resume_automation",
-     "arguments": {
-       "automationId": "automation-1"
-     }
-   }
-   ```
-
-5. **Script Continues** - Until next `pauseCheck` or completion
-
-6. **Check Status**
-   ```json
-   {
-     "tool": "get_automation_status",
-     "arguments": {
-       "automationId": "automation-1"
-     }
-   }
-   ```
-
 ## Configuration
 
 ### Environment Variables