@weavetab/mcp 2.5.0-beta.4 → 2.5.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.
Files changed (45) hide show
  1. package/LICENSE +212 -627
  2. package/README.md +25 -27
  3. package/dist/cdp/connector.js +2 -2
  4. package/dist/cli/plugin.d.ts +1 -0
  5. package/dist/cli/plugin.js +60 -4
  6. package/dist/config/loader.d.ts +1 -1
  7. package/dist/config/loader.js +1 -1
  8. package/dist/index.js +42 -6
  9. package/dist/plugin/interface.d.ts +14 -5
  10. package/dist/plugin/loader.d.ts +0 -3
  11. package/dist/plugin/loader.js +78 -15
  12. package/dist/plugin/registry.d.ts +2 -1
  13. package/dist/plugin/registry.js +21 -12
  14. package/dist/security/secrets.d.ts +6 -0
  15. package/dist/security/secrets.js +24 -0
  16. package/dist/server.d.ts +1 -1
  17. package/dist/server.js +37 -34
  18. package/dist/tools/browser_detect.js +2 -2
  19. package/dist/tools/captcha.js +1 -1
  20. package/dist/tools/navigate.d.ts +1 -1
  21. package/dist/tools/navigate.js +5 -5
  22. package/dist/tools/tabs.js +1 -1
  23. package/dist/version.d.ts +1 -1
  24. package/dist/version.js +1 -1
  25. package/docs/DOCUMENTATION.md +18 -11
  26. package/docs/PLUGINS.md +5 -5
  27. package/docs/TOOLS.md +54 -56
  28. package/docs/architecture/overview.md +1 -1
  29. package/docs/architecture/security.md +36 -35
  30. package/docs/architecture/transport.md +37 -37
  31. package/docs/cli/cli-commands.md +50 -44
  32. package/docs/cli/cli-flags.md +28 -20
  33. package/docs/cli/cli-scripting.md +35 -32
  34. package/docs/configuration/config-locations.md +23 -24
  35. package/docs/configuration/env-variables.md +19 -19
  36. package/docs/desktop-automation/electron-apps.md +3 -6
  37. package/docs/get-started/introduction.md +4 -4
  38. package/docs/get-started/setup-wizard.md +27 -26
  39. package/docs/tools/tools.md +1 -1
  40. package/docs/troubleshooting/trouble-browser.md +27 -27
  41. package/icon.png +0 -0
  42. package/mcp.json +3 -21
  43. package/package.json +3 -3
  44. package/server.json +6 -6
  45. package/smithery.yaml +7 -11
package/docs/TOOLS.md CHANGED
@@ -1,56 +1,54 @@
1
- # Weavetab MCP Tool Reference
2
-
3
- > **Version:** 2.5.0-beta.4 | **Total Tools:** 44 | **Architecture:** Layer 0 Direct CDP
4
-
5
- Weavetab provides 44 production-grade MCP tools organized into functional categories.
6
-
7
- | Tool Name | Category | Description | Key Features |
8
- | :--- | :--- | :--- | :--- |
9
- | `browser_map` | `vision` | Snapshot interactive DOM with stable ref IDs (w:NN). For complex SPAs, use scope or query to constrain tokens. Supports delta temporal diffing (up to 97% token reduction), semantic pruning (dropping hidden elements), Set-of-Marks visual grounding (visual: true / "auto" for canvas/WebGL pages), AX tree fallback (Shadow DOM traversal), scope filtering, query filtering, and forced rebuilds with automatic loop strike reset (force: true). | Semantic DOM pruning (up to 97% token reduction with delta), Set-of-Marks visual grounding (visual: true / "auto"), Per-tab snapshot temporal diffing (delta mode) |
10
- | `browser_navigate` | `navigation` | Navigate to a URL. Enforces domain security policies and rate limits prior to navigation. Waits for network idle and DOM readiness. Supports internal protocol schemes (e.g. weavetab://). | Domain policy engine and blocklist enforcement, Deterministic DOM stability and network idle waiting, weavetab:// internal protocol support |
11
- | `browser_click` | `input` | Click a DOM element. Physical click engine incorporating Bézier curve trajectory kinematics (Ghost Cursor). Multi-stage targeting fallback: mark number (SoM visual grounding) -> ref ID -> selector -> label -> intent -> coordinates -> backendNodeId. | Direct mark number targeting (mark: N) from visual mode, Bézier curve trajectory kinematics, Humanized acceleration and velocity curves |
12
- | `browser_type` | `input` | Type text into a single input field. Keystroke dispatch engine with per-character temporal jitter and burst profiling. Real-time DOM-diffing monitors stuck input state. Supports atomic clearFirst and clipboard paste modes. | Per-character temporal jitter simulation, Burst keystroke profiling, Stuck-typing loop detection via DOM diffing |
13
- | `browser_type_secret` | `input` | Inject a secret from an environment variable / secrets.json. Blind Injection: securely injects credentials without exposing sensitive values to the LLM context. Permanently masked as [REDACTED] in DOM maps and logs. | Zero LLM context exposure for credentials, Domain-scoped authorization checks, Shadow DOM input isolation |
14
- | `browser_key` | `input` | Press a keyboard key. Dispatches native hardware key events with modifier key support (Ctrl, Shift, Alt, Meta) to focused elements. | Native key code and key identifier mapping, Modifier key combination handling, Per-tab keyboard focus targeting |
15
- | `browser_scroll` | `input` | Scroll the page or targeted element. Smooth scrolling engine via CDP Input.dispatchMouseEvent wheel events. Supports directional delta scrolling and element-relative scroll centering. | Directional scrolling (up, down, left, right), Configurable pixel scroll distance, Element-relative scroll targeting via ref ID or label |
16
- | `browser_dialog` | `dialog_and_interaction` | Accept or dismiss JS dialogs (alert, confirm, prompt) via CDP Page.handleJavaScriptDialog. | Handling of alert, confirm, and prompt modal types, Accept and dismiss actions, Prompt response text payload submission |
17
- | `browser_burst` | `mission_execution` | HIGH-SPEED MULTI-ACTION PIPELINE: Executes 2 or more sequential browser actions in a single round-trip without waiting for LLM turns between steps. PREFER THIS over individual single-action calls to slash latency and token burn. Supports native primitives (browser_click, browser_fill, browser_type, browser_type_secret, browser_navigate, browser_key, browser_scroll, browser_wait, browser_map) plus compound macros (type_and_send, click_and_wait, navigate_and_read, scroll_and_read, fill_form). If compile_from_history: true is passed, automatically compiles and executes recent successful session trail actions into a burst macro. | Single-request multi-action pipeline execution with zero intermediate LLM round-trips, Compound macro abstractions (type_and_send, click_and_wait, navigate_and_read, scroll_and_read, fill_form, drag_and_drop, hover_and_read), Automatic session history compilation into replayable burst macros (compile_from_history: true) |
18
- | `browser_tabs` | `tabs` | Manage browser and Electron app tabs/windows (open, switch, close, list). Specify 'app' when targeting desktop apps (e.g. app: 'discord') to avoid opening web browser. | Single and batch tab operations, Duplicate tab consolidation, Crash session recovery (heal) |
19
- | `browser_wait` | `navigation` | Pause until a condition is met ('element', 'text', 'url', 'stable', 'network', 'auto'). Deterministic wait engine for asynchronous web state synchronization. | Element, text, URL, DOM stability, and network idle conditions, Configurable timeout thresholds, Per-tab asynchronous execution target |
20
- | `browser_captcha` | `safety` | Autonomous zero-API detection and solving of Turnstile, reCAPTCHA, GeeTest, and hCaptcha bot challenges using local CDP behavioral solvers. | Zero-API autonomous solving, Cloudflare Turnstile, reCAPTCHA v2/v3, GeeTest, and hCaptcha support, Human oversight fallback via wait_for_user |
21
- | `browser_thoughts` | `dialog_and_interaction` | Agent-to-user communication layer rendered in the middle down of the page. Supports question mode (interactive prompt with answer submission) and feedback mode (status, observation, decision, or warning update). Supports contextual element anchoring (anchor: 'w:NN') and visual styles ('observation', 'decision', 'warning', 'question'). | Middle-down floating card HUD with precision dark styling, Contextual element anchoring (anchor: 'w:NN') with auto-highlighting, Feedback mode (observation, decision, warning updates) |
22
- | `browser_pointer` | `input` | Advanced pointer control (hover, click, double_click, drag_and_drop) with Bézier curve kinematics. Supports waitForChild pattern for dynamic flyout menus. | Hover, click, double_click, and drag_and_drop actions, Bézier curve cursor motion, waitForChild trigger menu resolution |
23
- | `browser_select` | `input` | Select an option from a native dropdown by visible text or value. Uses native property setters and dispatches input/change events for framework compatibility (React, Vue, Angular). | Option matching by visible text or value, Framework-safe prototype property setter invocation, Synthetic input and change event dispatch |
24
- | `browser_fill` | `input` | Smart multi-field form-filling. Evaluates field control types (text, select, checkbox, radio, contenteditable) and processes inputs sequentially with atomic verification. | Multi-field batch input execution, Automatic control type classification, Per-field post-input verification |
25
- | `browser_highlight` | `canvas_and_visual` | Highlight elements on page. Renders temporary visual overlays over target elements without DOM tree mutations. Supports multi-element consideration overlays (refs: ['w:12', 'w:15']), presentation styles ('consideration', 'target', 'danger', 'success', 'shimmer'), floating badges, and configurable durations. | Multi-candidate consideration overlay (refs array), Five visual styles: consideration, target lock, danger, success, shimmer, Floating label badge display above highlighted elements |
26
- | `browser_upload` | `input` | Upload files to a file input. Bypasses OS native file pickers via CDP DOM.setFileInputFiles directly targeting file input node IDs using absolute file paths. | Direct CDP file payload injection, Multi-file payload support, Zero OS file picker interaction required |
27
- | `browser_find` | `vision` | Sub-5ms CDP text search. Zero token waste. Best for locating specific keywords/text on page without a full DOM walk. | Native CDP search (zero DOM walk overhead), Sub-5ms execution latency, Exact keyword matching and match indexing |
28
- | `browser_storage` | `storage_and_cookies` | Manage localStorage and sessionStorage. Reads, writes, and clears key-value pairs for the active origin. | localStorage and sessionStorage scope targeting, Atomic key-value retrieval and mutation, Origin storage purging |
29
- | `browser_checkpoint` | `storage_and_cookies` | Snapshot and restore browser state (cookies, localStorage, sessionStorage, and scroll/URL) into named checkpoints to time-travel and rollback failed automation branches. | Session state time-travel and rollback, Cookies backup and restoration (HttpOnly and Secure via CDP), LocalStorage and SessionStorage snapshotting |
30
- | `browser_network_intercept` | `network` | Intercept/stub network responses (mock APIs, block tracking) and capture raw protocol network telemetry (TLS/SSL certificate metadata, microsecond timing breakdown, and OS-level network failure reasons). | URL glob pattern matching and response mocking, TLS/SSL Certificate security metadata (issuer, protocol, validity, cipher), Microsecond Network Timing breakdown (DNS, TCP, SSL, send, TTFB, download) |
31
- | `browser_console` | `vision` | 1-5ms latency access to buffered browser console messages, JS exceptions, and network errors tracked via CDP Runtime.consoleAPICalled. | Buffered console output stream retrieval, Buffer clearance actions, Runtime exception stack capture |
32
- | `browser_pdf` | `output` | Print the current page to a PDF file via CDP Page.printToPDF with configurable orientation, scale, and page ranges. | Landscape and portrait orientation options, Print scale factor adjustment, Page range subset printing |
33
- | `browser_eval` | `evaluation` | Run arbitrary JS via CDP in page context via CDP Runtime.evaluate. Supports asynchronous evaluation and structured JSON serialization. | Page JS context execution, Async/await promise resolution, Structured JSON return serialization |
34
- | `browser_cookies` | `storage_and_cookies` | Manage browser cookies. Full CRUD management for HTTP and document cookies via CDP Network domain. | Cookie property retrieval, setting, and deletion, Domain and path attribute scoping |
35
- | `browser_canvas` | `canvas_and_visual` | For ALL canvas content (charts, games, graphs). Use get_image to read pixel data as Base64 PNG, draw to simulate programmatic coordinate gesture paths. | Base64 PNG pixel buffer export, Programmatic gesture path drawing, Canvas node targeting via ref ID or selector |
36
- | `browser_scrape` | `vision` | Sub-5ms latency, zero waste extraction via CSS or XPath selectors in a single CDP evaluation step. Returns structured text/attribute arrays. | CSS and XPath query evaluation, Targeted attribute extraction, Single-step execution (high throughput) |
37
- | `browser_snapshot` | `vision` | Capture or restore an MHTML snapshot (DOM + inline assets). Facilitates offline state serialization, replay verification, and compliance auditing. | Full DOM and asset stream serialization, Atomic capture and restore operations, Offline state audit capability |
38
- | `browser_screenshot` | `vision` | 95-135ms capture latency via CDP Page.captureScreenshot. Supports PNG and JPEG formats, full-page rendering, and clip region bounding boxes. | Full-page and viewport bounding box capture, PNG and JPEG format encoding, Custom clip region bounding box support |
39
- | `browser_viewport` | `device_and_environment` | Set viewport dimensions and device emulation (width, height, DPR, mobile, geolocation, timezone, locale, color scheme). | Viewport width, height, and DPR emulation, Mobile viewport and touch event emulation, Geolocation coordinate override |
40
- | `browser_clipboard` | `dialog_and_interaction` | Read or write to the system clipboard (plaintext or Base64 image payload data). | Read and write data operations, Plaintext and Base64 image payload format support |
41
- | `browser_inspect` | `vision` | 15-35ms latency, zero waste. Deep DOM inspection returning computed styles, inline styles, box model dimensions, and attached event listener types. | Computed CSS style property inspection, Event listener type registration enumeration, Box model geometry verification |
42
- | `browser_extract_design` | `vision` | Extract design tokens (colors, typography, spacing, shadows, CSS variables), semantic HTML layouts, and clean CSS into structured files and an LLM design blueprint. Ideal for cloning websites, UI components, and design systems with 100% pixel fidelity. | CSS custom properties and design token harvesting, Palette extraction and typography hierarchy mapping, Semantic clean DOM extraction with inline SVGs preserved |
43
- | `browser_automation` | `mission_execution` | Inject self-running background script for monitoring/polling. Inject persistent scripts into the page context for continuous event tracking. | Background script context injection, Named automation script management, Decoupled event monitoring lifecycle |
44
- | `browser_recording` | `output` | Record video screencasts of browser sessions. Automatically compiles captured frames into animated video files (.webp, .gif, .webm, .mp4) using native Node processing or system ffmpeg. | Native WebP/GIF animation compilation in pure Node, Configurable FPS and frame limits, FFmpeg fallback for WebM/MP4 encoding |
45
- | `browser_detect` | `tabs` | CRITICAL INITIALIZATION TOOL. Detect available browsers and configured desktop apps (Discord, Slack, etc.). Call this FIRST before interacting with the environment to know if apps are online/offline and what tabs they have open. | Local browser engine discovery, Engine CDP API coverage analysis, Tool compatibility reporting per browser engine |
46
- | `browser_performance` | `performance` | Retrieve page performance metrics. Collects Core Web Vitals (FCP, LCP, CLS) and detailed network resource timing distributions. | First Contentful Paint (FCP) and Largest Contentful Paint (LCP) capture, Cumulative Layout Shift (CLS) tracking, Resource loading timing distributions |
47
- | `browser_pattern_learn` | `memory` | Read (action=get), register (action=learn), update, or record execution outcome for a named workflow pattern on a given origin in ~/.weavetab-system/memory/sites/. Use action=get at session start to inspect site profiles and reliability scores. Use learn after completing a flow to persist it for future fast-path replay. | Site profile inspection via action=get (reads ~/.weavetab-system/memory/sites/), Named pattern creation and update (merge-on-write, no duplicates), Volatile selector stabilization before persistence |
48
- | `browser_github` | `github` | Interact with GitHub repositories without burning browser turns. Analyze repo trees, read raw source files, search/inspect issues, and examine PR diffs and review comments. | Action-based repo analysis, file reading, issues, and PR review, Zero GitHub API token requirement for raw reads, Automated active tab repository context resolution |
49
- | `browser_office` | `documents` | Read and extract structured content from office documents (Excel, Word, PDF, CSV) via live browser session cookies or local downloads directory. | In-session authenticated document fetching, Structured tabular extraction (.xlsx, .csv), Document text and metadata extraction (.docx, .pdf) |
50
- | `browser_emulate` | `environment` | Emulate browser environmental conditions over CDP: network throttling profiles, CPU slowdown multipliers, geolocation overrides, timezone IDs, and custom User-Agent strings. | Network throttling (Offline, Slow 3G, Fast 3G, 4G), CPU throttling multipliers, Geolocation and timezone overrides |
51
- | `list_plugins` | `plugins` | Inspect installed Weavetab SDK plugins, available unloadable plugins, tool overrides, custom schemas, and capability manifests. | Installed plugin discovery, Manifest and schema introspection, Ecosystem capability listing |
52
- | `load_plugin` | `plugins` | Dynamically load any published Weavetab plugin by npm package name into the active runtime with isolated sandboxing and hot tool registration. | Dynamic npm package loading, Hot tool registration with client notification, Isolated plugin execution context |
53
-
54
- ---
55
-
56
- *Auto-generated via `npm run docs:generate` on 2026-09-24.*
1
+ # Weavetab MCP Tool Reference
2
+
3
+ > **Version:** 2.5.0 | **Total Tools:** 42 | **Architecture:** Layer 0 Direct CDP
4
+
5
+ Weavetab provides 42 production-grade MCP tools organized into functional categories.
6
+
7
+ | Tool Name | Category | Description | Key Features |
8
+ | :--- | :--- | :--- | :--- |
9
+ | `browser_map` | `vision` | Snapshot interactive DOM with stable ref IDs (w:NN). For complex SPAs, use scope or query to constrain tokens. Supports delta temporal diffing (up to 97% token reduction), semantic pruning (dropping hidden elements), Set-of-Marks visual grounding (visual: true / "auto" for canvas/WebGL pages), AX tree fallback (Shadow DOM traversal), scope filtering, query filtering, and forced rebuilds with automatic loop strike reset (force: true). | Semantic DOM pruning (up to 97% token reduction with delta), Set-of-Marks visual grounding (visual: true / "auto"), Per-tab snapshot temporal diffing (delta mode) |
10
+ | `browser_navigate` | `navigation` | Navigate to a URL. Enforces domain security policies and rate limits prior to navigation. Waits for network idle and DOM readiness. Supports internal protocol schemes (e.g. weavetab://). | Domain policy engine and blocklist enforcement, Deterministic DOM stability and network idle waiting, weavetab:// internal protocol support |
11
+ | `browser_click` | `input` | Click a DOM element. Physical click engine incorporating Bézier curve trajectory kinematics (Ghost Cursor). Multi-stage targeting fallback: mark number (SoM visual grounding) -> ref ID -> selector -> label -> intent -> coordinates -> backendNodeId. | Direct mark number targeting (mark: N) from visual mode, Bézier curve trajectory kinematics, Humanized acceleration and velocity curves |
12
+ | `browser_type` | `input` | Type text into a single input field. Keystroke dispatch engine with per-character temporal jitter and burst profiling. Real-time DOM-diffing monitors stuck input state. Supports atomic clearFirst and clipboard paste modes. | Per-character temporal jitter simulation, Burst keystroke profiling, Stuck-typing loop detection via DOM diffing |
13
+ | `browser_type_secret` | `input` | Inject a secret from an environment variable / secrets.json. Blind Injection: securely injects credentials without exposing sensitive values to the LLM context. Permanently masked as [REDACTED] in DOM maps and logs. | Zero LLM context exposure for credentials, Domain-scoped authorization checks, Shadow DOM input isolation |
14
+ | `browser_key` | `input` | Press a keyboard key. Dispatches native hardware key events with modifier key support (Ctrl, Shift, Alt, Meta) to focused elements. | Native key code and key identifier mapping, Modifier key combination handling, Per-tab keyboard focus targeting |
15
+ | `browser_scroll` | `input` | Scroll the page or targeted element. Smooth scrolling engine via CDP Input.dispatchMouseEvent wheel events. Supports directional delta scrolling and element-relative scroll centering. | Directional scrolling (up, down, left, right), Configurable pixel scroll distance, Element-relative scroll targeting via ref ID or label |
16
+ | `browser_dialog` | `dialog_and_interaction` | Accept or dismiss JS dialogs (alert, confirm, prompt) via CDP Page.handleJavaScriptDialog. | Handling of alert, confirm, and prompt modal types, Accept and dismiss actions, Prompt response text payload submission |
17
+ | `browser_burst` | `mission_execution` | HIGH-SPEED MULTI-ACTION PIPELINE: Executes 2 or more sequential browser actions in a single round-trip without waiting for LLM turns between steps. PREFER THIS over individual single-action calls to slash latency and token burn. Supports native primitives (browser_click, browser_fill, browser_type, browser_type_secret, browser_navigate, browser_key, browser_scroll, browser_wait, browser_map) plus compound macros (type_and_send, click_and_wait, navigate_and_read, scroll_and_read, fill_form). If compile_from_history: true is passed, automatically compiles and executes recent successful session trail actions into a burst macro. | Single-request multi-action pipeline execution with zero intermediate LLM round-trips, Compound macro abstractions (type_and_send, click_and_wait, navigate_and_read, scroll_and_read, fill_form, drag_and_drop, hover_and_read), Automatic session history compilation into replayable burst macros (compile_from_history: true) |
18
+ | `browser_tabs` | `tabs` | Manage browser and Electron app tabs/windows (open, switch, close, list). Specify 'app' when targeting desktop apps (e.g. app: 'discord') to avoid opening web browser. | Single and batch tab operations, Duplicate tab consolidation, Crash session recovery (heal) |
19
+ | `browser_wait` | `navigation` | Pause until a condition is met ('element', 'text', 'url', 'stable', 'network', 'auto'). Deterministic wait engine for asynchronous web state synchronization. | Element, text, URL, DOM stability, and network idle conditions, Configurable timeout thresholds, Per-tab asynchronous execution target |
20
+ | `browser_captcha` | `safety` | Autonomous zero-API detection and solving of Turnstile, reCAPTCHA, GeeTest, and hCaptcha bot challenges using local CDP behavioral solvers. | Zero-API autonomous solving, Cloudflare Turnstile, reCAPTCHA v2/v3, GeeTest, and hCaptcha support, Human oversight fallback via wait_for_user |
21
+ | `browser_thoughts` | `dialog_and_interaction` | Agent-to-user communication layer rendered in the middle down of the page. Supports question mode (interactive prompt with answer submission) and feedback mode (status, observation, decision, or warning update). Supports contextual element anchoring (anchor: 'w:NN') and visual styles ('observation', 'decision', 'warning', 'question'). | Middle-down floating card HUD with precision dark styling, Contextual element anchoring (anchor: 'w:NN') with auto-highlighting, Feedback mode (observation, decision, warning updates) |
22
+ | `browser_pointer` | `input` | Advanced pointer control (hover, click, double_click, drag_and_drop) with Bézier curve kinematics. Supports waitForChild pattern for dynamic flyout menus. | Hover, click, double_click, and drag_and_drop actions, Bézier curve cursor motion, waitForChild trigger menu resolution |
23
+ | `browser_select` | `input` | Select an option from a native dropdown by visible text or value. Uses native property setters and dispatches input/change events for framework compatibility (React, Vue, Angular). | Option matching by visible text or value, Framework-safe prototype property setter invocation, Synthetic input and change event dispatch |
24
+ | `browser_fill` | `input` | Smart multi-field form-filling. Evaluates field control types (text, select, checkbox, radio, contenteditable) and processes inputs sequentially with atomic verification. | Multi-field batch input execution, Automatic control type classification, Per-field post-input verification |
25
+ | `browser_highlight` | `canvas_and_visual` | Highlight elements on page. Renders temporary visual overlays over target elements without DOM tree mutations. Supports multi-element consideration overlays (refs: ['w:12', 'w:15']), presentation styles ('consideration', 'target', 'danger', 'success', 'shimmer'), floating badges, and configurable durations. | Multi-candidate consideration overlay (refs array), Five visual styles: consideration, target lock, danger, success, shimmer, Floating label badge display above highlighted elements |
26
+ | `browser_upload` | `input` | Upload files to a file input. Bypasses OS native file pickers via CDP DOM.setFileInputFiles directly targeting file input node IDs using absolute file paths. | Direct CDP file payload injection, Multi-file payload support, Zero OS file picker interaction required |
27
+ | `browser_find` | `vision` | Sub-5ms CDP text search. Zero token waste. Best for locating specific keywords/text on page without a full DOM walk. | Native CDP search (zero DOM walk overhead), Sub-5ms execution latency, Exact keyword matching and match indexing |
28
+ | `browser_storage` | `storage_and_cookies` | Manage localStorage and sessionStorage. Reads, writes, and clears key-value pairs for the active origin. | localStorage and sessionStorage scope targeting, Atomic key-value retrieval and mutation, Origin storage purging |
29
+ | `browser_checkpoint` | `storage_and_cookies` | Snapshot and restore browser state (cookies, localStorage, sessionStorage, and scroll/URL) into named checkpoints to time-travel and rollback failed automation branches. | Session state time-travel and rollback, Cookies backup and restoration (HttpOnly and Secure via CDP), LocalStorage and SessionStorage snapshotting |
30
+ | `browser_network_intercept` | `network` | Intercept/stub network responses (mock APIs, block tracking) and capture raw protocol network telemetry (TLS/SSL certificate metadata, microsecond timing breakdown, and OS-level network failure reasons). | URL glob pattern matching and response mocking, TLS/SSL Certificate security metadata (issuer, protocol, validity, cipher), Microsecond Network Timing breakdown (DNS, TCP, SSL, send, TTFB, download) |
31
+ | `browser_console` | `vision` | 1-5ms latency access to buffered browser console messages, JS exceptions, and network errors tracked via CDP Runtime.consoleAPICalled. | Buffered console output stream retrieval, Buffer clearance actions, Runtime exception stack capture |
32
+ | `browser_pdf` | `output` | Print the current page to a PDF file via CDP Page.printToPDF with configurable orientation, scale, and page ranges. | Landscape and portrait orientation options, Print scale factor adjustment, Page range subset printing |
33
+ | `browser_eval` | `evaluation` | Run arbitrary JS via CDP in page context via CDP Runtime.evaluate. Supports asynchronous evaluation and structured JSON serialization. | Page JS context execution, Async/await promise resolution, Structured JSON return serialization |
34
+ | `browser_cookies` | `storage_and_cookies` | Manage browser cookies. Full CRUD management for HTTP and document cookies via CDP Network domain. | Cookie property retrieval, setting, and deletion, Domain and path attribute scoping |
35
+ | `browser_canvas` | `canvas_and_visual` | For ALL canvas content (charts, games, graphs). Use get_image to read pixel data as Base64 PNG, draw to simulate programmatic coordinate gesture paths. | Base64 PNG pixel buffer export, Programmatic gesture path drawing, Canvas node targeting via ref ID or selector |
36
+ | `browser_scrape` | `vision` | Sub-5ms latency, zero waste extraction via CSS or XPath selectors in a single CDP evaluation step. Returns structured text/attribute arrays. | CSS and XPath query evaluation, Targeted attribute extraction, Single-step execution (high throughput) |
37
+ | `browser_snapshot` | `vision` | Capture or restore an MHTML snapshot (DOM + inline assets). Facilitates offline state serialization, replay verification, and compliance auditing. | Full DOM and asset stream serialization, Atomic capture and restore operations, Offline state audit capability |
38
+ | `browser_screenshot` | `vision` | 95-135ms capture latency via CDP Page.captureScreenshot. Supports PNG and JPEG formats, full-page rendering, and clip region bounding boxes. | Full-page and viewport bounding box capture, PNG and JPEG format encoding, Custom clip region bounding box support |
39
+ | `browser_viewport` | `device_and_environment` | Set viewport dimensions and device emulation (width, height, DPR, mobile, geolocation, timezone, locale, color scheme). | Viewport width, height, and DPR emulation, Mobile viewport and touch event emulation, Geolocation coordinate override |
40
+ | `browser_clipboard` | `dialog_and_interaction` | Read or write to the system clipboard (plaintext or Base64 image payload data). | Read and write data operations, Plaintext and Base64 image payload format support |
41
+ | `browser_inspect` | `vision` | 15-35ms latency, zero waste. Deep DOM inspection returning computed styles, inline styles, box model dimensions, and attached event listener types. | Computed CSS style property inspection, Event listener type registration enumeration, Box model geometry verification |
42
+ | `browser_extract_design` | `vision` | Extract design tokens (colors, typography, spacing, shadows, CSS variables), semantic HTML layouts, and clean CSS into structured files and an LLM design blueprint. Ideal for cloning websites, UI components, and design systems with 100% pixel fidelity. | CSS custom properties and design token harvesting, Palette extraction and typography hierarchy mapping, Semantic clean DOM extraction with inline SVGs preserved |
43
+ | `browser_automation` | `mission_execution` | Inject self-running background script for monitoring/polling. Inject persistent scripts into the page context for continuous event tracking. | Background script context injection, Named automation script management, Decoupled event monitoring lifecycle |
44
+ | `browser_recording` | `output` | Record video screencasts of browser sessions. Automatically compiles captured frames into animated video files (.webp, .gif, .webm, .mp4) using native Node processing or system ffmpeg. | Native WebP/GIF animation compilation in pure Node, Configurable FPS and frame limits, FFmpeg fallback for WebM/MP4 encoding |
45
+ | `browser_detect` | `tabs` | CRITICAL INITIALIZATION TOOL. Detect available browsers and configured desktop apps (Discord, Slack, etc.). Call this FIRST before interacting with the environment to know if apps are online/offline and what tabs they have open. | Local browser engine discovery, Engine CDP API coverage analysis, Tool compatibility reporting per browser engine |
46
+ | `browser_performance` | `performance` | Retrieve page performance metrics. Collects Core Web Vitals (FCP, LCP, CLS) and detailed network resource timing distributions. | First Contentful Paint (FCP) and Largest Contentful Paint (LCP) capture, Cumulative Layout Shift (CLS) tracking, Resource loading timing distributions |
47
+ | `browser_pattern_learn` | `memory` | Read (action=get), register (action=learn), update, or record execution outcome for a named workflow pattern on a given origin in ~/.weavetab-system/memory/sites/. Use action=get at session start to inspect site profiles and reliability scores. Use learn after completing a flow to persist it for future fast-path replay. | Site profile inspection via action=get (reads ~/.weavetab-system/memory/sites/), Named pattern creation and update (merge-on-write, no duplicates), Volatile selector stabilization before persistence |
48
+ | `browser_github` | `github` | Interact with GitHub repositories without burning browser turns. Analyze repo trees, read raw source files, search/inspect issues, and examine PR diffs and review comments. | Action-based repo analysis, file reading, issues, and PR review, Zero GitHub API token requirement for raw reads, Automated active tab repository context resolution |
49
+ | `browser_office` | `documents` | Read and extract structured content from office documents (Excel, Word, PDF, CSV) via live browser session cookies or local downloads directory. | In-session authenticated document fetching, Structured tabular extraction (.xlsx, .csv), Document text and metadata extraction (.docx, .pdf) |
50
+ | `browser_emulate` | `environment` | Emulate browser environmental conditions over CDP: network throttling profiles, CPU slowdown multipliers, geolocation overrides, timezone IDs, and custom User-Agent strings. | Network throttling (Offline, Slow 3G, Fast 3G, 4G), CPU throttling multipliers, Geolocation and timezone overrides |
51
+
52
+ ---
53
+
54
+ *Auto-generated via `npm run docs:generate` on 2026-10-17.*
@@ -15,7 +15,7 @@ Weavetab is decomposed into **five functional layers**, all running in-process w
15
15
 
16
16
  | # | Layer | Responsibility |
17
17
  |---|---|---|
18
- | 1 | **Transport** | JSON-RPC 2.0 over stdio or WebSocket (`--ws --port 3000`) |
18
+ | 1 | **Transport** | JSON-RPC 2.0 over stdio (default) or WebSocket (`--ws --port 3000`) |
19
19
  | 2 | **Security & Governance** | Domain blacklist, rate limiter (mutex), RBAC roles, policy engine, root guard |
20
20
  | 3 | **Intelligence Engine** | Session memory, semantic delta diffing, DOM pruner, loop detection, intent intercept |
21
21
  | 4 | **Sensor Systems** | Network telemetry, DOM mutation observer, human pacing, agent state machine |
@@ -1,35 +1,36 @@
1
- ---
2
- title: "Security Model"
3
- description: "Layered defenses that gate every tool invocation."
4
- product: mcp
5
- section: architecture
6
- icon: ShieldCheck
7
- slug: security
8
- ---
9
-
10
- # Security Model
11
-
12
- Weavetab executes direct Layer 0 CDP commands — security is layered and **deny-by-default for risky surfaces**.
13
-
14
- ## Defense-in-Depth Mechanisms
15
-
16
- | Mechanism | Description |
17
- |---|---|
18
- | **Domain Blacklist** | Hard-blocked high-risk domains (banking, IAM consoles, internal infrastructure). |
19
- | **Domain Policy Engine** | Per-domain enforcement modes: `allow`, `read-only`, `deny`, `audit`. |
20
- | **Localhost Binding** | WebSocket server and CDP endpoints strictly bound to `127.0.0.1`. |
21
- | **Rate Limiting** | Mutex-enforced actions-per-minute rate limiter. |
22
- | **RBAC Roles** | 4 strict roles gating tool access (`admin`, `operator`, `viewer`, `automation`). |
23
- | **Root Guard** | Prevents execution as root/superuser on Unix systems. |
24
- | **Blind Injection** | Credential injection from `secrets.json` without exposing raw text to LLM context. |
25
- | **Shadow DOM Isolation** | All injected HUD and modal overlays run in isolated Shadow DOM trees. |
26
- | **Path Traversal Guard** | File upload and download paths strictly validated against path traversal. |
27
-
28
- ## RBAC Role Matrix
29
-
30
- | Tool Category | admin | operator | viewer | automation |
31
- |---|:---:|:---:|:---:|:---:|
32
- | Mutation tools (`click`, `type`, `fill`, etc.) | yes | yes | no | yes |
33
- | Read-only tools (`map`, `find`, `scrape`, `screenshot`) | yes | yes | yes | yes |
34
- | High-level orchestration (`burst`, `plan`, `wait`) | yes | yes | no | yes |
35
- | System management (`detect`, `reset_loop_counter`) | yes | no | no | no |
1
+ ---
2
+ title: "Security Model"
3
+ description: "Layered defenses that gate every tool invocation."
4
+ product: mcp
5
+ section: architecture
6
+ icon: ShieldCheck
7
+ slug: security
8
+ ---
9
+
10
+ # Security Model
11
+
12
+ Weavetab executes direct Layer 0 CDP commands — security is layered and **deny-by-default for risky surfaces**.
13
+
14
+ ## Defense-in-Depth Mechanisms
15
+
16
+ | Mechanism | Description |
17
+ |---|---|
18
+ | **Domain Blacklist** | Hard-blocked high-risk domains (banking, IAM consoles, internal infrastructure). |
19
+ | **Domain Policy Engine** | Per-domain enforcement modes: `allow`, `read-only`, `deny`, `audit`. |
20
+ | **Localhost Binding** | WebSocket server and CDP endpoints strictly bound to `127.0.0.1`. |
21
+ | **Rate Limiting** | Mutex-enforced actions-per-minute rate limiter. |
22
+ | **RBAC Roles** | 5 roles gating tool access (`admin`, `operator`, `viewer`, `automation`, `system`). |
23
+ | **Root Guard** | Prevents execution as root/superuser on Unix systems. |
24
+ | **Blind Injection** | Credential injection from `secrets.json` without exposing raw text to LLM context. |
25
+ | **Shadow DOM Isolation** | All injected HUD and modal overlays run in isolated Shadow DOM trees. |
26
+ | **Path Traversal Guard** | File upload and download paths strictly validated against path traversal. |
27
+
28
+ ## RBAC Role Matrix
29
+
30
+ | Tool Category | admin | operator | viewer | automation | system |
31
+ |---|:---:|:---:|:---:|:---:|:---:|
32
+ | Mutation tools (`click`, `type`, `fill`, etc.) | yes | yes | no | yes | no |
33
+ | Read-only tools (`map`, `find`, `scrape`, `screenshot`) | yes | yes | yes | yes | no |
34
+ | High-level orchestration (`burst`, `automation`, `wait`) | yes | yes | no | yes | no |
35
+ | Interactive HUD (`thoughts`) | yes | yes | no | no | yes |
36
+ | System introspection (`detect`, `performance`, `checkpoint`) | yes | yes | no | yes | yes |
@@ -1,37 +1,37 @@
1
- ---
2
- title: "Transport Modes"
3
- description: "stdio vs WebSocket — pick the right wire for your client."
4
- product: mcp
5
- section: architecture
6
- icon: Cable
7
- slug: transport
8
- ---
9
-
10
- # Transport Modes
11
-
12
- | Mode | Flag | Protocol | Use Case |
13
- |---|---|---|---|
14
- | **stdio** | *(default)* | JSON-RPC 2.0 / stdio | Claude Desktop, Cursor, VS Code Copilot, Antigravity |
15
- | **WebSocket** | `--ws` | JSON-RPC 2.0 / WebSocket | Custom agents, Python/Go backends, remote daemons, n8n |
16
-
17
- ## stdio (Default)
18
-
19
- The MCP client spawns Weavetab as a child process and pipes messages over stdin/stdout. No network port is opened:
20
-
21
- ```json
22
- {
23
- "mcpServers": {
24
- "weavetab": {
25
- "command": "weavetab"
26
- }
27
- }
28
- }
29
- ```
30
-
31
- ## WebSocket
32
-
33
- ```bash
34
- weavetab --ws --port 3000
35
- ```
36
-
37
- WebSocket mode binds strictly to `127.0.0.1` for local security. Front it with your own TLS/auth layer if exposing across a private network.
1
+ ---
2
+ title: "Transport Modes"
3
+ description: "stdio vs WebSocket — pick the right wire for your client."
4
+ product: mcp
5
+ section: architecture
6
+ icon: Cable
7
+ slug: transport
8
+ ---
9
+
10
+ # Transport Modes
11
+
12
+ | Mode | Flag | Protocol | Use Case |
13
+ |---|---|---|---|
14
+ | **stdio** | *(default)* | JSON-RPC 2.0 / stdio | Claude Desktop, Cursor, VS Code Copilot, Antigravity |
15
+ | **WebSocket** | `--ws [--port N]` | JSON-RPC 2.0 / WebSocket | Custom agents, Python/Go backends, remote daemons, n8n |
16
+
17
+ ## stdio (Default)
18
+
19
+ The MCP client spawns Weavetab as a child process and pipes messages over stdin/stdout. No network port is opened:
20
+
21
+ ```json
22
+ {
23
+ "mcpServers": {
24
+ "weavetab": {
25
+ "command": "weavetab"
26
+ }
27
+ }
28
+ }
29
+ ```
30
+
31
+ ## WebSocket
32
+
33
+ ```bash
34
+ weavetab --ws --port 3000
35
+ ```
36
+
37
+ Starts the daemon on `127.0.0.1:3000` (override with `--port <n>` / `--port=<n>`). The daemon binds strictly to loopback for local security — front it with your own TLS/auth layer if exposing across a private network.
@@ -1,44 +1,50 @@
1
- ---
2
- title: "Commands"
3
- description: "Reference for every top-level subcommand."
4
- product: mcp
5
- section: cli
6
- icon: ListTree
7
- slug: cli-commands
8
- ---
9
-
10
- # Commands
11
-
12
- ## Server Commands
13
-
14
- | Command | Description |
15
- |---|---|
16
- | `weavetab` | Start the MCP server (stdio mode — default for MCP clients). When run in a TTY without arguments, launches the interactive UI menu. |
17
- | `weavetab config` | Launch the 5-phase interactive configuration wizard. |
18
- | `weavetab view` | Display the current active configuration report. Press **[R]** to view raw JSON, **[Q]** to quit. |
19
- | `weavetab reset` | Purge browser profiles, lockfiles, mutexes, session registries, and kill orphan browser processes. Accepts `--yes`/`-y` to skip confirmation prompts. |
20
- | `weavetab reload-ext` | Send a reload signal to the Weavetab browser extension via CDP `Runtime.evaluate`. |
21
- | `weavetab help` / `--help` | Show full CLI help message with all commands, flags, and environment variables. |
22
-
23
- ## Secrets Management
24
-
25
- Credentials are stored in `~/.weavetab/secrets.json` (global) or `.weavetab/secrets.json` (project-scoped). Values are never echoed to the terminal.
26
-
27
- | Command | Description |
28
- |---|---|
29
- | `weavetab secrets set <KEY>` | Store a new encrypted secret. Prompts for value (hidden input) and allowed domains (comma-separated). |
30
- | `weavetab secrets list` | List all stored secrets (key names only, values hidden). Shows domains and last-updated timestamps. |
31
- | `weavetab secrets rm <KEY>` | Remove a secret by key name. |
32
- | `weavetab secrets init --project` | Initialize a project-scoped `.weavetab/secrets.json` file. |
33
-
34
- ## Interactive TTY Menu
35
-
36
- When run without arguments in a TTY terminal, Weavetab opens an interactive keyboard-driven menu:
37
-
38
- | Key | Action |
39
- |---|---|
40
- | `[C]` | Launch the configuration wizard |
41
- | `[V]` | View current active configuration |
42
- | `[R]` | Purge browser profiles and lockfiles |
43
- | `[H]` | Show help information |
44
- | `[Q]` | Exit Weavetab |
1
+ ---
2
+ title: "Commands"
3
+ description: "Reference for every top-level subcommand."
4
+ product: mcp
5
+ section: cli
6
+ icon: ListTree
7
+ slug: cli-commands
8
+ ---
9
+
10
+ # Commands
11
+
12
+ ## Server Commands
13
+
14
+ | Command | Description |
15
+ |---|---|
16
+ | `weavetab` | Start the MCP server (stdio mode — default for MCP clients). When run in a TTY without arguments, launches the interactive UI menu. |
17
+ | `weavetab --ws [--port N]` | Start the WebSocket daemon on `127.0.0.1` (default port `3000`). |
18
+ | `weavetab --version` | Print version and exit. |
19
+ | `weavetab config` | Launch the 6-phase interactive configuration wizard. |
20
+ | `weavetab view` | Display the current active configuration report. Press **[R]** to view raw JSON, **[Q]** to quit. |
21
+ | `weavetab reset` | Purge browser profiles, lockfiles, mutexes, session registries, and kill orphan browser processes. Accepts `--yes`/`-y` to skip confirmation prompts. |
22
+ | `weavetab reload-ext` | Send a reload signal to the Weavetab browser extension via CDP `Runtime.evaluate`. |
23
+ | `weavetab plugin <add\|browse\|search\|list\|remove\|verify>` | Manage plugins — see `weavetab plugin --help`. |
24
+ | `weavetab skills [options]` | Install or update AI agent skills (passthrough to `@weavetab/skills`). |
25
+ | `weavetab help` / `--help` | Show full CLI help message with all commands, flags, and environment variables. |
26
+
27
+ ## Secrets Management
28
+
29
+ Credentials are stored in `~/.weavetab/secrets.json` (global) or `.weavetab/secrets.json` (project-scoped). Values are never echoed to the terminal.
30
+
31
+ | Command | Description |
32
+ |---|---|
33
+ | `weavetab secrets set <KEY>` | Store a new encrypted secret. Prompts for value (hidden input) and allowed domains (comma-separated). |
34
+ | `weavetab secrets list` | List all stored secrets (key names only, values hidden). Shows domains and last-updated timestamps. |
35
+ | `weavetab secrets rm <KEY>` | Remove a secret by key name. |
36
+ | `weavetab secrets init --project` | Initialize a project-scoped `.weavetab/secrets.json` file. |
37
+
38
+ ## Interactive TTY Menu
39
+
40
+ When run without arguments in a TTY terminal, Weavetab opens an interactive keyboard-driven menu:
41
+
42
+ | Key | Action |
43
+ |---|---|
44
+ | `[C]` | Launch the configuration wizard |
45
+ | `[V]` | View current active configuration |
46
+ | `[P]` | List installed Weavetab plugins |
47
+ | `[R]` | Purge browser profiles and lockfiles |
48
+ | `[H]` | Show help information |
49
+ | `[G]` / `[N]` / `[W]` | Open GitHub / npm / website links |
50
+ | `[Q]` | Exit Weavetab |
@@ -1,20 +1,28 @@
1
- ---
2
- title: "Flags"
3
- description: "Global flags accepted by the server."
4
- product: mcp
5
- section: cli
6
- icon: Flag
7
- slug: cli-flags
8
- ---
9
-
10
- # Flags
11
-
12
- | Flag | Type | Description |
13
- |---|---|---|
14
- | `--version` | boolean | Print CLI version and exit |
15
- | `--help` / `-h` | boolean | Show help message and exit |
16
- | `--ws` | boolean | Start server in WebSocket mode instead of stdio |
17
- | `--port <port>` | number | Port for WebSocket server (default `3000`) |
18
- | `--headless` | boolean | Run browser in headless mode |
19
- | `--role <role>` | enum | Override RBAC role (`admin`, `operator`, `viewer`, `automation`) |
20
- | `--yes` / `-y` | boolean | Skip confirmation prompt when running `weavetab reset` |
1
+ ---
2
+ title: "Flags"
3
+ description: "Global flags accepted by the CLI."
4
+ product: mcp
5
+ section: cli
6
+ icon: Flag
7
+ slug: cli-flags
8
+ ---
9
+
10
+ # Flags
11
+
12
+ Only these flags are parsed by the CLI (`MCP/src/index.ts`). Anything else is ignored.
13
+
14
+ | Flag | Type | Description |
15
+ |---|---|---|
16
+ | `--help` / `-h` | boolean | Show help message and exit |
17
+ | `help` | command | Show help message and exit |
18
+ | `--version` / `-v` | boolean | Print version and exit |
19
+ | `--ws` | boolean | Start the WebSocket daemon instead of stdio |
20
+ | `--port <port>` / `--port=<port>` | number | Port for the WebSocket daemon (default `3000`) |
21
+ | `--yes` / `-y` | boolean | Skip confirmation prompt when running `weavetab reset` / `reload` |
22
+ | `--official` / `-O` | boolean | Prefer the official `@weavetab/plugin-<name>` candidate (`plugin add`) |
23
+ | `--community` / `-C` | boolean | Prefer the community package candidate (`plugin add`) |
24
+ | `--refresh` | boolean | Invalidate and refresh the verified plugin cache (`plugin`) |
25
+ | `--project` | boolean | Project-scoped secrets file (`secrets init --project`) |
26
+
27
+ Notes:
28
+ - There are no `--headless` / `--role` CLI flags. Browser headless mode and RBAC role come from `~/.weavetab/config.json` (`weavetab config` / `weavetab view`). The wizard offers `admin` / `operator` / `viewer` / `automation`.
@@ -1,32 +1,35 @@
1
- ---
2
- title: "Scripting & CI/CD"
3
- description: "Chain CLI calls in shell scripts and CI."
4
- product: mcp
5
- section: cli
6
- icon: FileCode
7
- slug: cli-scripting
8
- ---
9
-
10
- # Scripting & CI/CD
11
-
12
- ## Shell Scripting
13
-
14
- ```bash
15
- # Reset before a fresh test run
16
- weavetab reset --yes
17
-
18
- # List stored secrets
19
- weavetab secrets list
20
-
21
- # Start the MCP server in WebSocket mode for custom scripts
22
- weavetab --ws --port 3000 --headless &
23
- ```
24
-
25
- ## CI/CD Pipeline
26
-
27
- ```bash
28
- # In GitHub Actions or Docker CI
29
- npm install -g @weavetab/mcp
30
- weavetab reset --yes
31
- weavetab --ws --port 3000 --headless &
32
- ```
1
+ ---
2
+ title: "Scripting & CI/CD"
3
+ description: "Chain CLI calls in shell scripts and CI."
4
+ product: mcp
5
+ section: cli
6
+ icon: FileCode
7
+ slug: cli-scripting
8
+ ---
9
+
10
+ # Scripting & CI/CD
11
+
12
+ ## Shell Scripting
13
+
14
+ ```bash
15
+ # Reset before a fresh test run
16
+ weavetab reset --yes
17
+
18
+ # List stored secrets
19
+ weavetab secrets list
20
+
21
+ # List installed plugins
22
+ weavetab plugin list
23
+
24
+ # Start the MCP server in WebSocket daemon mode for custom scripts
25
+ weavetab --ws --port 3000 &
26
+ ```
27
+
28
+ ## CI/CD Pipeline
29
+
30
+ ```bash
31
+ # In GitHub Actions or Docker CI
32
+ npm install -g @weavetab/mcp
33
+ weavetab reset --yes
34
+ weavetab --ws --port 3000 &
35
+ ```
@@ -1,24 +1,23 @@
1
- ---
2
- title: "Locations & Merge"
3
- description: "Three-tier merge: local → global → built-in defaults."
4
- product: mcp
5
- section: configuration
6
- icon: FolderTree
7
- slug: config-locations
8
- ---
9
-
10
- # Config Locations & Merge Priority
11
-
12
- ## Priority Tiers
13
-
14
- 1. **Local (Project-scoped)** — `./.weavetab/config.json` (takes top priority)
15
- 2. **Global** — `~/.weavetab/config.json`
16
- 3. **Built-in defaults** — defined in `DEFAULT_CONFIG`
17
-
18
- ## Live Reload
19
-
20
- A debounced file watcher (150 ms) reloads the in-memory configuration on change. In-flight tool executions complete on the existing configuration; subsequent calls automatically pick up the new values.
21
-
22
- ## Corrupt File Quarantine
23
-
24
- If a configuration file contains invalid JSON, Weavetab automatically quarantines the file to `config.broken.<timestamp>.json` and safely falls back to the next tier without crashing.
1
+ ---
2
+ title: "Locations & Merge"
3
+ description: "Two-tier merge: global config → built-in defaults."
4
+ product: mcp
5
+ section: configuration
6
+ icon: FolderTree
7
+ slug: config-locations
8
+ ---
9
+
10
+ # Config Locations & Merge Priority
11
+
12
+ ## Priority Tiers
13
+
14
+ 1. **Global** — `~/.weavetab/config.json` (the only config file Weavetab reads)
15
+ 2. **Built-in defaults** — defined in `DEFAULT_CONFIG`
16
+
17
+ ## Live Reload
18
+
19
+ A debounced file watcher (150 ms) reloads the in-memory configuration on change. In-flight tool executions complete on the existing configuration; subsequent calls automatically pick up the new values.
20
+
21
+ ## Corrupt File Quarantine
22
+
23
+ If a configuration file contains invalid JSON, Weavetab automatically quarantines the file to `config.broken.<timestamp>.json` and safely falls back to the next tier without crashing.
@@ -1,19 +1,19 @@
1
- ---
2
- title: "Environment Variables"
3
- description: "Runtime environment variables that override config."
4
- product: mcp
5
- section: configuration
6
- icon: Variable
7
- slug: env-variables
8
- ---
9
-
10
- # Environment Variables
11
-
12
- | Variable | Description |
13
- |---|---|
14
- | `CHROME_PATH` | Absolute path to Chromium/Chrome binary |
15
- | `WEAVETAB_CONFIG` | Path to a custom config file |
16
- | `WEAVETAB_ROLE` | Override RBAC role at runtime (`admin`, `operator`, `viewer`, `automation`) |
17
- | `WEAVETAB_DEV` | Set to `1` to enable verbose CDP dev logging |
18
- | `WT_AGENT_ID` | Override the auto-generated agent UUID |
19
- | `WT_PROXY_URL` | Set outbound HTTP/SOCKS proxy server URL |
1
+ ---
2
+ title: "Environment Variables"
3
+ description: "Runtime environment variables that override config."
4
+ product: mcp
5
+ section: configuration
6
+ icon: Variable
7
+ slug: env-variables
8
+ ---
9
+
10
+ # Environment Variables
11
+
12
+ Only these two are read at runtime (`MCP/src/config/loader.ts`). Everything else
13
+ (browser path, role, headless, dev mode) lives in `~/.weavetab/config.json`
14
+ — run `weavetab config` to change it.
15
+
16
+ | Variable | Description |
17
+ |---|---|
18
+ | `WT_AGENT_ID` | Override the auto-generated agent UUID |
19
+ | `WT_PROXY_URL` | Set outbound HTTP/SOCKS proxy server URL |