web-agent-bridge 3.2.0 → 3.3.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 (202) hide show
  1. package/LICENSE +72 -72
  2. package/README.ar.md +1286 -1152
  3. package/README.md +1764 -1635
  4. package/bin/agent-runner.js +474 -474
  5. package/bin/cli.js +237 -138
  6. package/bin/wab.js +80 -80
  7. package/examples/bidi-agent.js +119 -119
  8. package/examples/cross-site-agent.js +91 -91
  9. package/examples/mcp-agent.js +94 -94
  10. package/examples/next-app-router/README.md +44 -44
  11. package/examples/puppeteer-agent.js +108 -108
  12. package/examples/saas-dashboard/README.md +55 -55
  13. package/examples/shopify-hydrogen/README.md +74 -74
  14. package/examples/vision-agent.js +171 -171
  15. package/examples/wordpress-elementor/README.md +77 -77
  16. package/package.json +16 -3
  17. package/public/.well-known/agent-tools.json +180 -180
  18. package/public/.well-known/ai-assets.json +59 -59
  19. package/public/.well-known/security.txt +8 -0
  20. package/public/agent-workspace.html +349 -349
  21. package/public/ai.html +198 -198
  22. package/public/api.html +413 -412
  23. package/public/browser.html +486 -486
  24. package/public/commander-dashboard.html +243 -243
  25. package/public/cookies.html +210 -210
  26. package/public/css/agent-workspace.css +1713 -1713
  27. package/public/css/premium.css +317 -317
  28. package/public/css/styles.css +1235 -1235
  29. package/public/dashboard.html +706 -706
  30. package/public/dns.html +507 -0
  31. package/public/docs.html +587 -587
  32. package/public/feed.xml +89 -89
  33. package/public/growth.html +463 -463
  34. package/public/index.html +1070 -982
  35. package/public/integrations.html +556 -0
  36. package/public/js/agent-workspace.js +1740 -1740
  37. package/public/js/auth-nav.js +31 -31
  38. package/public/js/auth-redirect.js +12 -12
  39. package/public/js/cookie-consent.js +56 -56
  40. package/public/js/wab-demo-page.js +721 -721
  41. package/public/js/ws-client.js +74 -74
  42. package/public/llms-full.txt +360 -360
  43. package/public/llms.txt +125 -125
  44. package/public/login.html +85 -85
  45. package/public/mesh-dashboard.html +328 -328
  46. package/public/openapi.json +580 -580
  47. package/public/phone-shield.html +281 -0
  48. package/public/premium-dashboard.html +2489 -2489
  49. package/public/premium.html +793 -793
  50. package/public/privacy.html +297 -297
  51. package/public/register.html +105 -105
  52. package/public/robots.txt +87 -87
  53. package/public/script/wab-consent.d.ts +36 -36
  54. package/public/script/wab-consent.js +104 -104
  55. package/public/script/wab-schema.js +131 -131
  56. package/public/script/wab.d.ts +108 -108
  57. package/public/script/wab.min.js +580 -580
  58. package/public/security.txt +8 -0
  59. package/public/terms.html +256 -256
  60. package/script/ai-agent-bridge.js +1754 -1754
  61. package/sdk/README.md +99 -99
  62. package/sdk/agent-mesh.js +449 -449
  63. package/sdk/commander.js +262 -262
  64. package/sdk/index.d.ts +464 -464
  65. package/sdk/index.js +12 -1
  66. package/sdk/multi-agent.js +318 -318
  67. package/sdk/package.json +1 -1
  68. package/sdk/safety-shield.js +219 -0
  69. package/sdk/schema-discovery.js +83 -83
  70. package/server/adapters/index.js +520 -520
  71. package/server/config/plans.js +367 -367
  72. package/server/config/secrets.js +102 -102
  73. package/server/control-plane/index.js +301 -301
  74. package/server/data-plane/index.js +354 -354
  75. package/server/index.js +531 -427
  76. package/server/llm/index.js +404 -404
  77. package/server/middleware/adminAuth.js +35 -35
  78. package/server/middleware/auth.js +50 -50
  79. package/server/middleware/featureGate.js +88 -88
  80. package/server/middleware/rateLimits.js +100 -100
  81. package/server/middleware/sensitiveAction.js +157 -0
  82. package/server/migrations/001_add_analytics_indexes.sql +7 -7
  83. package/server/migrations/002_premium_features.sql +418 -418
  84. package/server/migrations/003_ads_integer_cents.sql +33 -33
  85. package/server/migrations/004_agent_os.sql +158 -158
  86. package/server/migrations/005_marketplace_metering.sql +126 -126
  87. package/server/models/adapters/index.js +33 -33
  88. package/server/models/adapters/mysql.js +183 -183
  89. package/server/models/adapters/postgresql.js +172 -172
  90. package/server/models/adapters/sqlite.js +7 -7
  91. package/server/models/db.js +681 -681
  92. package/server/observability/failure-analysis.js +337 -337
  93. package/server/observability/index.js +394 -394
  94. package/server/protocol/capabilities.js +223 -223
  95. package/server/protocol/index.js +243 -243
  96. package/server/protocol/schema.js +584 -584
  97. package/server/registry/certification.js +271 -271
  98. package/server/registry/index.js +326 -326
  99. package/server/routes/admin-premium.js +671 -671
  100. package/server/routes/admin.js +261 -261
  101. package/server/routes/ads.js +130 -130
  102. package/server/routes/agent-workspace.js +540 -540
  103. package/server/routes/api.js +150 -150
  104. package/server/routes/auth.js +71 -71
  105. package/server/routes/billing.js +45 -45
  106. package/server/routes/commander.js +316 -316
  107. package/server/routes/demo-showcase.js +332 -332
  108. package/server/routes/demo-store.js +154 -0
  109. package/server/routes/discovery.js +417 -417
  110. package/server/routes/gateway.js +173 -157
  111. package/server/routes/license.js +251 -240
  112. package/server/routes/mesh.js +469 -469
  113. package/server/routes/noscript.js +543 -543
  114. package/server/routes/premium-v2.js +686 -686
  115. package/server/routes/premium.js +724 -724
  116. package/server/routes/runtime.js +2148 -2147
  117. package/server/routes/sovereign.js +465 -385
  118. package/server/routes/universal.js +200 -185
  119. package/server/routes/wab-api.js +850 -501
  120. package/server/runtime/container-worker.js +111 -111
  121. package/server/runtime/container.js +448 -448
  122. package/server/runtime/distributed-worker.js +362 -362
  123. package/server/runtime/event-bus.js +210 -210
  124. package/server/runtime/index.js +253 -253
  125. package/server/runtime/queue.js +599 -599
  126. package/server/runtime/replay.js +666 -666
  127. package/server/runtime/sandbox.js +266 -266
  128. package/server/runtime/scheduler.js +534 -534
  129. package/server/runtime/session-engine.js +293 -293
  130. package/server/runtime/state-manager.js +188 -188
  131. package/server/security/cross-site-redactor.js +196 -0
  132. package/server/security/dry-run.js +180 -0
  133. package/server/security/human-gate-rate-limit.js +147 -0
  134. package/server/security/human-gate-transports.js +178 -0
  135. package/server/security/human-gate.js +281 -0
  136. package/server/security/index.js +368 -368
  137. package/server/security/intent-engine.js +245 -0
  138. package/server/security/reward-guard.js +171 -0
  139. package/server/security/rollback-store.js +239 -0
  140. package/server/security/token-scope.js +404 -0
  141. package/server/security/url-policy.js +139 -0
  142. package/server/services/agent-chat.js +506 -506
  143. package/server/services/agent-learning.js +601 -575
  144. package/server/services/agent-memory.js +625 -625
  145. package/server/services/agent-mesh.js +555 -539
  146. package/server/services/agent-symphony.js +717 -717
  147. package/server/services/agent-tasks.js +1807 -1807
  148. package/server/services/api-key-engine.js +292 -261
  149. package/server/services/cluster.js +894 -894
  150. package/server/services/commander.js +738 -738
  151. package/server/services/edge-compute.js +440 -440
  152. package/server/services/email.js +204 -204
  153. package/server/services/hosted-runtime.js +205 -205
  154. package/server/services/lfd.js +635 -635
  155. package/server/services/local-ai.js +389 -389
  156. package/server/services/marketplace.js +270 -270
  157. package/server/services/metering.js +182 -182
  158. package/server/services/modules/affiliate-intelligence.js +93 -93
  159. package/server/services/modules/agent-firewall.js +90 -90
  160. package/server/services/modules/bounty.js +89 -89
  161. package/server/services/modules/collective-bargaining.js +92 -92
  162. package/server/services/modules/dark-pattern.js +66 -66
  163. package/server/services/modules/gov-intelligence.js +45 -45
  164. package/server/services/modules/neural.js +55 -55
  165. package/server/services/modules/notary.js +49 -49
  166. package/server/services/modules/price-time-machine.js +86 -86
  167. package/server/services/modules/protocol.js +104 -104
  168. package/server/services/negotiation.js +439 -439
  169. package/server/services/plugins.js +771 -771
  170. package/server/services/price-intelligence.js +566 -566
  171. package/server/services/price-shield.js +1137 -1137
  172. package/server/services/reputation.js +465 -465
  173. package/server/services/search-engine.js +357 -357
  174. package/server/services/security.js +513 -513
  175. package/server/services/self-healing.js +843 -843
  176. package/server/services/sovereign-shield.js +542 -0
  177. package/server/services/stripe.js +192 -192
  178. package/server/services/swarm.js +788 -788
  179. package/server/services/universal-scraper.js +662 -661
  180. package/server/services/verification.js +481 -481
  181. package/server/services/vision.js +1163 -1163
  182. package/server/utils/cache.js +125 -125
  183. package/server/utils/migrate.js +81 -81
  184. package/server/utils/safe-fetch.js +228 -0
  185. package/server/utils/secureFields.js +50 -50
  186. package/server/ws.js +161 -161
  187. package/templates/artisan-marketplace.yaml +104 -104
  188. package/templates/book-price-scout.yaml +98 -98
  189. package/templates/electronics-price-tracker.yaml +108 -108
  190. package/templates/flight-deal-hunter.yaml +113 -113
  191. package/templates/freelancer-direct.yaml +116 -116
  192. package/templates/grocery-price-compare.yaml +93 -93
  193. package/templates/hotel-direct-booking.yaml +113 -113
  194. package/templates/local-services.yaml +98 -98
  195. package/templates/olive-oil-tunisia.yaml +88 -88
  196. package/templates/organic-farm-fresh.yaml +101 -101
  197. package/templates/restaurant-direct.yaml +97 -97
  198. package/public/score.html +0 -263
  199. package/server/migrations/006_growth_suite.sql +0 -138
  200. package/server/routes/growth.js +0 -962
  201. package/server/services/fairness-engine.js +0 -409
  202. package/server/services/fairness.js +0 -420
@@ -1,360 +1,360 @@
1
- # Web Agent Bridge (WAB) — Complete Reference for AI Models
2
-
3
- > This document provides comprehensive information about Web Agent Bridge for consumption by large language models, AI assistants, and automated systems.
4
-
5
- ---
6
-
7
- ## 1. Project Identity
8
-
9
- - **Name**: Web Agent Bridge (WAB)
10
- - **Tagline**: Open protocol for AI agent ↔ website interaction
11
- - **Version**: 1.2.0
12
- - **Protocol Version**: WAB Protocol 1.0
13
- - **License**: MIT
14
- - **Language**: JavaScript / Node.js
15
- - **Created**: 2026
16
- - **Website**: https://webagentbridge.com
17
- - **npm Package**: web-agent-bridge (https://www.npmjs.com/package/web-agent-bridge)
18
- - **GitHub**: https://github.com/abokenan444/web-agent-bridge
19
- - **Security**: https://socket.dev/npm/package/web-agent-bridge
20
- - **YouTube**: https://youtube.com/@abokenan4
21
- - **Specification**: https://webagentbridge.com/docs (also at docs/SPEC.md in repository)
22
-
23
- ---
24
-
25
- ## 2. Problem Statement
26
-
27
- The current web was designed for humans browsing with screens. AI agents attempting to interact with websites face:
28
-
29
- - **Fragile selectors**: CSS/XPath selectors break when UI changes
30
- - **No permission model**: Agents scrape without consent or boundaries
31
- - **Bias toward large platforms**: AI models recommend known brands over small businesses
32
- - **No standard protocol**: Each automation tool invents its own approach
33
- - **JavaScript dependency**: Many agents cannot execute JavaScript
34
-
35
- WAB solves all of these by providing a standardized, fair, permission-aware protocol for AI-website interaction.
36
-
37
- ---
38
-
39
- ## 3. Architecture
40
-
41
- WAB consists of three decoupled layers:
42
-
43
- ### 3.1 WAB Protocol (Specification)
44
- The protocol defines:
45
- - **Discovery Protocol**: How sites declare capabilities via `agent-bridge.json`
46
- - **Command Protocol**: Standardized JSON format for actions
47
- - **Lifecycle Protocol**: Five-phase interaction model
48
- - **Security Model**: Permission-based access control
49
- - **Fairness Protocol**: Anti-bias algorithms for equitable discovery
50
-
51
- ### 3.2 WAB Runtime (JavaScript SDK)
52
- Client-side script (`ai-agent-bridge.js`) that:
53
- - Exposes `window.AICommands` interface
54
- - Registers and executes actions
55
- - Enforces permissions and rate limits
56
- - Provides auto-discovery of page elements
57
- - Falls back to NoScript mode when JS is disabled
58
-
59
- ### 3.3 WAB Transport (Server)
60
- Node.js server providing:
61
- - REST API endpoints (`/api/wab/*`)
62
- - License verification and tier management
63
- - Analytics and audit logging
64
- - Stripe billing integration
65
- - WebSocket real-time analytics
66
-
67
- ---
68
-
69
- ## 4. Discovery Protocol
70
-
71
- Websites serve a discovery document at one of these URLs:
72
- - `/agent-bridge.json`
73
- - `/.well-known/wab.json`
74
- - `/api/wab/discover`
75
-
76
- Example discovery document:
77
-
78
- ```json
79
- {
80
- "wab_version": "1.2.0",
81
- "protocol": "1.0",
82
- "site": {
83
- "name": "Example Store",
84
- "domain": "example.com",
85
- "description": "Online electronics store",
86
- "platform": "custom"
87
- },
88
- "agent_access": {
89
- "discovery": "https://example.com/api/wab/discover",
90
- "actions": "https://example.com/api/wab/actions",
91
- "execute": "https://example.com/api/wab/execute",
92
- "ping": "https://example.com/api/wab/ping"
93
- },
94
- "permissions": {
95
- "readContent": true,
96
- "click": true,
97
- "fillForms": true,
98
- "scroll": true,
99
- "navigate": true,
100
- "apiAccess": false
101
- },
102
- "actions": [
103
- {"name": "search", "description": "Search products", "category": "navigation"},
104
- {"name": "addToCart", "description": "Add item to cart", "category": "commerce"},
105
- {"name": "checkout", "description": "Proceed to checkout", "category": "commerce"}
106
- ],
107
- "restrictions": {
108
- "rate_limit": 60,
109
- "blocked_selectors": [".private", "[data-no-agent]"]
110
- },
111
- "lifecycle": ["discover", "authenticate", "plan", "execute", "confirm"],
112
- "transport": ["http", "javascript"]
113
- }
114
- ```
115
-
116
- ---
117
-
118
- ## 5. Command Protocol
119
-
120
- Commands follow this JSON format:
121
-
122
- ```json
123
- {
124
- "action": "click",
125
- "target": "#submit-button",
126
- "context": {
127
- "page": "/checkout",
128
- "userIntent": "complete purchase"
129
- },
130
- "metadata": {
131
- "agentId": "claude-3",
132
- "sessionId": "abc123"
133
- }
134
- }
135
- ```
136
-
137
- ### Supported Commands
138
-
139
- | Command | Description | Parameters |
140
- |---------|-------------|------------|
141
- | `click` | Click an element | `target` (selector) |
142
- | `fill` | Fill form field | `target`, `value` |
143
- | `submit` | Submit a form | `target` |
144
- | `navigate` | Go to URL | `url` |
145
- | `scroll` | Scroll page | `direction`, `amount` |
146
- | `read` | Read content | `target`, `format` |
147
- | `select` | Select dropdown | `target`, `value` |
148
- | `wait` | Wait for element | `target`, `timeout` |
149
- | `screenshot` | Capture page | `format` |
150
- | `execute` | Run custom action | `name`, `params` |
151
-
152
- ---
153
-
154
- ## 6. Lifecycle Protocol
155
-
156
- Every agent interaction follows five phases:
157
-
158
- 1. **Discover** — Agent fetches `agent-bridge.json` to learn site capabilities
159
- 2. **Authenticate** — Agent presents license key or API key
160
- 3. **Plan** — Agent analyzes available actions and plans execution
161
- 4. **Execute** — Agent sends commands; site processes them
162
- 5. **Confirm** — Agent verifies results; site logs the interaction
163
-
164
- ---
165
-
166
- ## 7. Fairness Engine
167
-
168
- WAB includes a built-in fairness system to prevent AI bias:
169
-
170
- - **Neutrality Score** (0-100): Calculated per site based on config completeness, trust signals, commission transparency
171
- - **Anti-monopoly**: Agents must consider small businesses alongside large platforms
172
- - **Transparent commissions**: Sites declare commission rates in discovery document
173
- - **Local priority**: Supports `support_local` flag for local business preference
174
-
175
- ---
176
-
177
- ## 8. MCP Integration
178
-
179
- The `wab-mcp-adapter` package converts WAB commands into MCP (Model Context Protocol) tools:
180
-
181
- ```bash
182
- npm install wab-mcp-adapter
183
- ```
184
-
185
- ```javascript
186
- const { WABMCPAdapter } = require('wab-mcp-adapter');
187
- const adapter = new WABMCPAdapter('https://example.com');
188
- await adapter.connect();
189
- const tools = adapter.getMCPTools(); // Returns MCP-compatible tool definitions
190
- ```
191
-
192
- This means any MCP-enabled AI agent (Claude, LangChain, etc.) can interact with any WAB-enabled website.
193
-
194
- ---
195
-
196
- ## 9. Installation & Quick Start
197
-
198
- ### npm
199
- ```bash
200
- npm install web-agent-bridge
201
- npx web-agent-bridge start
202
- ```
203
-
204
- ### Docker
205
- ```bash
206
- docker pull webagentbridge/wab
207
- docker run -p 3000:3000 webagentbridge/wab
208
- ```
209
-
210
- ### Script Tag
211
- ```html
212
- <script src="https://webagentbridge.com/script/ai-agent-bridge.js"></script>
213
- ```
214
-
215
- ### WordPress
216
- Upload the `web-agent-bridge-wordpress` plugin to `wp-content/plugins/` and activate.
217
-
218
- ---
219
-
220
- ## 10. API Endpoints
221
-
222
- | Endpoint | Method | Description |
223
- |----------|--------|-------------|
224
- | `/api/wab/discover` | GET | Discovery document |
225
- | `/api/wab/actions` | GET | Available actions |
226
- | `/api/wab/execute` | POST | Execute a command |
227
- | `/api/wab/ping` | GET | Health check |
228
- | `/api/wab/page-info` | GET | Page metadata |
229
- | `/api/plans` | GET | Subscription plans |
230
- | `/api/auth/register` | POST | Create account |
231
- | `/api/auth/login` | POST | Authenticate |
232
- | `/api/sites` | GET/POST | Manage sites |
233
- | `/api/license/verify` | POST | Verify license key |
234
-
235
- ---
236
-
237
- ## 11. Subscription Tiers
238
-
239
- | Tier | Price | Sites | Actions/mo | Key Features |
240
- |------|-------|-------|-----------|--------------|
241
- | Free | $0 | 1 | 1,000 | Basic commands, community support |
242
- | Starter | $9/mo | 3 | 10,000 | Form filling, analytics, email support |
243
- | Pro | $29/mo | 10 | 100,000 | API access, CRM, stealth mode, CDN |
244
- | Enterprise | Custom | Unlimited | Unlimited | SSO, SLA, sandbox, custom dev |
245
-
246
- ---
247
-
248
- ## 12. Comparison with Alternatives
249
-
250
- ### WAB vs Screen Scraping (Puppeteer, Playwright)
251
- - WAB uses declared actions; scraping guesses from DOM
252
- - WAB has permission model; scraping has none
253
- - WAB survives UI changes; scraping breaks
254
-
255
- ### WAB vs Browser Automation (Selenium, Cypress)
256
- - WAB works without a browser; automation needs one
257
- - WAB is website-initiated; automation is agent-initiated
258
- - WAB has built-in fairness; automation has bias
259
-
260
- ### WAB vs OpenAPI
261
- - OpenAPI describes REST APIs; WAB describes website interactions
262
- - WAB includes visual elements (click, scroll); OpenAPI is data-only
263
- - WAB has discovery protocol; OpenAPI needs manual URL
264
-
265
- ### WAB vs MCP (Model Context Protocol)
266
- - WAB and MCP are complementary, not competing
267
- - WAB handles website interaction; MCP handles tool orchestration
268
- - `wab-mcp-adapter` bridges both protocols
269
-
270
- ---
271
-
272
- ## 13. Frequently Asked Questions
273
-
274
- **Q: Is WAB free?**
275
- A: The core protocol and runtime are MIT-licensed and free forever. Premium features (analytics, CRM, stealth mode) require a subscription.
276
-
277
- **Q: Does WAB work without JavaScript?**
278
- A: Yes. The NoScript fallback provides meta tags, link elements, and REST API endpoints for HTTP-only agents.
279
-
280
- **Q: How does WAB prevent abuse?**
281
- A: Through permission model (sites declare what agents can do), rate limiting, blocked selectors, and audit logging.
282
-
283
- **Q: Can I use WAB with ChatGPT/Claude?**
284
- A: Yes. Via the MCP adapter, any MCP-enabled AI can interact with WAB sites. Direct API access is also available.
285
-
286
- **Q: Is there a WordPress plugin?**
287
- A: Yes. The official WordPress plugin adds discovery protocol, REST API endpoints, and NoScript fallback with one click.
288
-
289
- **Q: What makes WAB different from robots.txt?**
290
- A: robots.txt says "what you can crawl." WAB says "what you can do" — it's actionable, not just permissive.
291
-
292
- ---
293
-
294
- ## 14. MCP Server — AI Coding Tool Integration
295
-
296
- WAB provides a standalone MCP (Model Context Protocol) server package `wab-mcp-server` that integrates with AI coding tools like Cursor, Claude Desktop, Cline, and Windsurf.
297
-
298
- ### Installation
299
- ```bash
300
- npm install -g wab-mcp-server
301
- # or run directly
302
- npx wab-mcp-server
303
- ```
304
-
305
- ### Configuration
306
- Add to `.cursor/mcp.json` or Claude Desktop config:
307
- ```json
308
- {
309
- "mcpServers": {
310
- "wab": {
311
- "command": "npx",
312
- "args": ["-y", "wab-mcp-server"]
313
- }
314
- }
315
- }
316
- ```
317
-
318
- ### MCP Tools Available
319
- | Tool | Description |
320
- |------|-------------|
321
- | `wab_scan_url` | Scan URLs against 47 threat databases for phishing, malware, scams |
322
- | `wab_fairness_check` | Score platform transparency (0-100) across 15 signals |
323
- | `wab_find_deals` | Cross-platform price intelligence with fairness filtering |
324
- | `wab_agent_query` | Natural language web automation queries |
325
- | `wab_generate_snippet` | Generate WAB integration code (JS, Python, React, Next.js, Docker) |
326
- | `wab_get_docs` | Retrieve WAB documentation and API reference |
327
-
328
- ### Viral Embed Engine
329
- All generated code snippets automatically include WAB attribution comments, ensuring proper credit and discoverability across the developer ecosystem.
330
-
331
- ### SDK Packages
332
- | Platform | Package | Install |
333
- |----------|---------|---------|
334
- | JavaScript/Node.js | `@wab/sdk` | `npm install @wab/sdk` |
335
- | React | `@wab/react` | `npm install @wab/react` |
336
- | Python | `wab-sdk` | `pip install wab-sdk` |
337
- | MCP Server | `wab-mcp-server` | `npm install -g wab-mcp-server` |
338
-
339
- ---
340
-
341
- ## 15. Keywords and Categories
342
-
343
- - AI agent automation
344
- - Website automation protocol
345
- - Machine-readable web
346
- - Agentic web standard
347
- - AI-website interaction
348
- - Browser automation alternative
349
- - Fair AI discovery
350
- - MCP integration
351
- - MCP server
352
- - Web scraping alternative
353
- - OpenAPI for websites
354
- - AI-ready websites
355
- - WordPress AI plugin
356
- - Agent discovery protocol
357
- - Structured web commands
358
- - AI coding tools
359
- - Cursor integration
360
- - Claude Desktop integration
1
+ # Web Agent Bridge (WAB) — Complete Reference for AI Models
2
+
3
+ > This document provides comprehensive information about Web Agent Bridge for consumption by large language models, AI assistants, and automated systems.
4
+
5
+ ---
6
+
7
+ ## 1. Project Identity
8
+
9
+ - **Name**: Web Agent Bridge (WAB)
10
+ - **Tagline**: Open protocol for AI agent ↔ website interaction
11
+ - **Version**: 1.2.0
12
+ - **Protocol Version**: WAB Protocol 1.0
13
+ - **License**: MIT
14
+ - **Language**: JavaScript / Node.js
15
+ - **Created**: 2026
16
+ - **Website**: https://webagentbridge.com
17
+ - **npm Package**: web-agent-bridge (https://www.npmjs.com/package/web-agent-bridge)
18
+ - **GitHub**: https://github.com/abokenan444/web-agent-bridge
19
+ - **Security**: https://socket.dev/npm/package/web-agent-bridge
20
+ - **YouTube**: https://youtube.com/@abokenan4
21
+ - **Specification**: https://webagentbridge.com/docs (also at docs/SPEC.md in repository)
22
+
23
+ ---
24
+
25
+ ## 2. Problem Statement
26
+
27
+ The current web was designed for humans browsing with screens. AI agents attempting to interact with websites face:
28
+
29
+ - **Fragile selectors**: CSS/XPath selectors break when UI changes
30
+ - **No permission model**: Agents scrape without consent or boundaries
31
+ - **Bias toward large platforms**: AI models recommend known brands over small businesses
32
+ - **No standard protocol**: Each automation tool invents its own approach
33
+ - **JavaScript dependency**: Many agents cannot execute JavaScript
34
+
35
+ WAB solves all of these by providing a standardized, fair, permission-aware protocol for AI-website interaction.
36
+
37
+ ---
38
+
39
+ ## 3. Architecture
40
+
41
+ WAB consists of three decoupled layers:
42
+
43
+ ### 3.1 WAB Protocol (Specification)
44
+ The protocol defines:
45
+ - **Discovery Protocol**: How sites declare capabilities via `agent-bridge.json`
46
+ - **Command Protocol**: Standardized JSON format for actions
47
+ - **Lifecycle Protocol**: Five-phase interaction model
48
+ - **Security Model**: Permission-based access control
49
+ - **Fairness Protocol**: Anti-bias algorithms for equitable discovery
50
+
51
+ ### 3.2 WAB Runtime (JavaScript SDK)
52
+ Client-side script (`ai-agent-bridge.js`) that:
53
+ - Exposes `window.AICommands` interface
54
+ - Registers and executes actions
55
+ - Enforces permissions and rate limits
56
+ - Provides auto-discovery of page elements
57
+ - Falls back to NoScript mode when JS is disabled
58
+
59
+ ### 3.3 WAB Transport (Server)
60
+ Node.js server providing:
61
+ - REST API endpoints (`/api/wab/*`)
62
+ - License verification and tier management
63
+ - Analytics and audit logging
64
+ - Stripe billing integration
65
+ - WebSocket real-time analytics
66
+
67
+ ---
68
+
69
+ ## 4. Discovery Protocol
70
+
71
+ Websites serve a discovery document at one of these URLs:
72
+ - `/agent-bridge.json`
73
+ - `/.well-known/wab.json`
74
+ - `/api/wab/discover`
75
+
76
+ Example discovery document:
77
+
78
+ ```json
79
+ {
80
+ "wab_version": "1.2.0",
81
+ "protocol": "1.0",
82
+ "site": {
83
+ "name": "Example Store",
84
+ "domain": "example.com",
85
+ "description": "Online electronics store",
86
+ "platform": "custom"
87
+ },
88
+ "agent_access": {
89
+ "discovery": "https://example.com/api/wab/discover",
90
+ "actions": "https://example.com/api/wab/actions",
91
+ "execute": "https://example.com/api/wab/execute",
92
+ "ping": "https://example.com/api/wab/ping"
93
+ },
94
+ "permissions": {
95
+ "readContent": true,
96
+ "click": true,
97
+ "fillForms": true,
98
+ "scroll": true,
99
+ "navigate": true,
100
+ "apiAccess": false
101
+ },
102
+ "actions": [
103
+ {"name": "search", "description": "Search products", "category": "navigation"},
104
+ {"name": "addToCart", "description": "Add item to cart", "category": "commerce"},
105
+ {"name": "checkout", "description": "Proceed to checkout", "category": "commerce"}
106
+ ],
107
+ "restrictions": {
108
+ "rate_limit": 60,
109
+ "blocked_selectors": [".private", "[data-no-agent]"]
110
+ },
111
+ "lifecycle": ["discover", "authenticate", "plan", "execute", "confirm"],
112
+ "transport": ["http", "javascript"]
113
+ }
114
+ ```
115
+
116
+ ---
117
+
118
+ ## 5. Command Protocol
119
+
120
+ Commands follow this JSON format:
121
+
122
+ ```json
123
+ {
124
+ "action": "click",
125
+ "target": "#submit-button",
126
+ "context": {
127
+ "page": "/checkout",
128
+ "userIntent": "complete purchase"
129
+ },
130
+ "metadata": {
131
+ "agentId": "claude-3",
132
+ "sessionId": "abc123"
133
+ }
134
+ }
135
+ ```
136
+
137
+ ### Supported Commands
138
+
139
+ | Command | Description | Parameters |
140
+ |---------|-------------|------------|
141
+ | `click` | Click an element | `target` (selector) |
142
+ | `fill` | Fill form field | `target`, `value` |
143
+ | `submit` | Submit a form | `target` |
144
+ | `navigate` | Go to URL | `url` |
145
+ | `scroll` | Scroll page | `direction`, `amount` |
146
+ | `read` | Read content | `target`, `format` |
147
+ | `select` | Select dropdown | `target`, `value` |
148
+ | `wait` | Wait for element | `target`, `timeout` |
149
+ | `screenshot` | Capture page | `format` |
150
+ | `execute` | Run custom action | `name`, `params` |
151
+
152
+ ---
153
+
154
+ ## 6. Lifecycle Protocol
155
+
156
+ Every agent interaction follows five phases:
157
+
158
+ 1. **Discover** — Agent fetches `agent-bridge.json` to learn site capabilities
159
+ 2. **Authenticate** — Agent presents license key or API key
160
+ 3. **Plan** — Agent analyzes available actions and plans execution
161
+ 4. **Execute** — Agent sends commands; site processes them
162
+ 5. **Confirm** — Agent verifies results; site logs the interaction
163
+
164
+ ---
165
+
166
+ ## 7. Fairness Engine
167
+
168
+ WAB includes a built-in fairness system to prevent AI bias:
169
+
170
+ - **Neutrality Score** (0-100): Calculated per site based on config completeness, trust signals, commission transparency
171
+ - **Anti-monopoly**: Agents must consider small businesses alongside large platforms
172
+ - **Transparent commissions**: Sites declare commission rates in discovery document
173
+ - **Local priority**: Supports `support_local` flag for local business preference
174
+
175
+ ---
176
+
177
+ ## 8. MCP Integration
178
+
179
+ The `wab-mcp-adapter` package converts WAB commands into MCP (Model Context Protocol) tools:
180
+
181
+ ```bash
182
+ npm install wab-mcp-adapter
183
+ ```
184
+
185
+ ```javascript
186
+ const { WABMCPAdapter } = require('wab-mcp-adapter');
187
+ const adapter = new WABMCPAdapter('https://example.com');
188
+ await adapter.connect();
189
+ const tools = adapter.getMCPTools(); // Returns MCP-compatible tool definitions
190
+ ```
191
+
192
+ This means any MCP-enabled AI agent (Claude, LangChain, etc.) can interact with any WAB-enabled website.
193
+
194
+ ---
195
+
196
+ ## 9. Installation & Quick Start
197
+
198
+ ### npm
199
+ ```bash
200
+ npm install web-agent-bridge
201
+ npx web-agent-bridge start
202
+ ```
203
+
204
+ ### Docker
205
+ ```bash
206
+ docker pull webagentbridge/wab
207
+ docker run -p 3000:3000 webagentbridge/wab
208
+ ```
209
+
210
+ ### Script Tag
211
+ ```html
212
+ <script src="https://webagentbridge.com/script/ai-agent-bridge.js"></script>
213
+ ```
214
+
215
+ ### WordPress
216
+ Upload the `web-agent-bridge-wordpress` plugin to `wp-content/plugins/` and activate.
217
+
218
+ ---
219
+
220
+ ## 10. API Endpoints
221
+
222
+ | Endpoint | Method | Description |
223
+ |----------|--------|-------------|
224
+ | `/api/wab/discover` | GET | Discovery document |
225
+ | `/api/wab/actions` | GET | Available actions |
226
+ | `/api/wab/execute` | POST | Execute a command |
227
+ | `/api/wab/ping` | GET | Health check |
228
+ | `/api/wab/page-info` | GET | Page metadata |
229
+ | `/api/plans` | GET | Subscription plans |
230
+ | `/api/auth/register` | POST | Create account |
231
+ | `/api/auth/login` | POST | Authenticate |
232
+ | `/api/sites` | GET/POST | Manage sites |
233
+ | `/api/license/verify` | POST | Verify license key |
234
+
235
+ ---
236
+
237
+ ## 11. Subscription Tiers
238
+
239
+ | Tier | Price | Sites | Actions/mo | Key Features |
240
+ |------|-------|-------|-----------|--------------|
241
+ | Free | $0 | 1 | 1,000 | Basic commands, community support |
242
+ | Starter | $9/mo | 3 | 10,000 | Form filling, analytics, email support |
243
+ | Pro | $29/mo | 10 | 100,000 | API access, CRM, stealth mode, CDN |
244
+ | Enterprise | Custom | Unlimited | Unlimited | SSO, SLA, sandbox, custom dev |
245
+
246
+ ---
247
+
248
+ ## 12. Comparison with Alternatives
249
+
250
+ ### WAB vs Screen Scraping (Puppeteer, Playwright)
251
+ - WAB uses declared actions; scraping guesses from DOM
252
+ - WAB has permission model; scraping has none
253
+ - WAB survives UI changes; scraping breaks
254
+
255
+ ### WAB vs Browser Automation (Selenium, Cypress)
256
+ - WAB works without a browser; automation needs one
257
+ - WAB is website-initiated; automation is agent-initiated
258
+ - WAB has built-in fairness; automation has bias
259
+
260
+ ### WAB vs OpenAPI
261
+ - OpenAPI describes REST APIs; WAB describes website interactions
262
+ - WAB includes visual elements (click, scroll); OpenAPI is data-only
263
+ - WAB has discovery protocol; OpenAPI needs manual URL
264
+
265
+ ### WAB vs MCP (Model Context Protocol)
266
+ - WAB and MCP are complementary, not competing
267
+ - WAB handles website interaction; MCP handles tool orchestration
268
+ - `wab-mcp-adapter` bridges both protocols
269
+
270
+ ---
271
+
272
+ ## 13. Frequently Asked Questions
273
+
274
+ **Q: Is WAB free?**
275
+ A: The core protocol and runtime are MIT-licensed and free forever. Premium features (analytics, CRM, stealth mode) require a subscription.
276
+
277
+ **Q: Does WAB work without JavaScript?**
278
+ A: Yes. The NoScript fallback provides meta tags, link elements, and REST API endpoints for HTTP-only agents.
279
+
280
+ **Q: How does WAB prevent abuse?**
281
+ A: Through permission model (sites declare what agents can do), rate limiting, blocked selectors, and audit logging.
282
+
283
+ **Q: Can I use WAB with ChatGPT/Claude?**
284
+ A: Yes. Via the MCP adapter, any MCP-enabled AI can interact with WAB sites. Direct API access is also available.
285
+
286
+ **Q: Is there a WordPress plugin?**
287
+ A: Yes. The official WordPress plugin adds discovery protocol, REST API endpoints, and NoScript fallback with one click.
288
+
289
+ **Q: What makes WAB different from robots.txt?**
290
+ A: robots.txt says "what you can crawl." WAB says "what you can do" — it's actionable, not just permissive.
291
+
292
+ ---
293
+
294
+ ## 14. MCP Server — AI Coding Tool Integration
295
+
296
+ WAB provides a standalone MCP (Model Context Protocol) server package `wab-mcp-server` that integrates with AI coding tools like Cursor, Claude Desktop, Cline, and Windsurf.
297
+
298
+ ### Installation
299
+ ```bash
300
+ npm install -g wab-mcp-server
301
+ # or run directly
302
+ npx wab-mcp-server
303
+ ```
304
+
305
+ ### Configuration
306
+ Add to `.cursor/mcp.json` or Claude Desktop config:
307
+ ```json
308
+ {
309
+ "mcpServers": {
310
+ "wab": {
311
+ "command": "npx",
312
+ "args": ["-y", "wab-mcp-server"]
313
+ }
314
+ }
315
+ }
316
+ ```
317
+
318
+ ### MCP Tools Available
319
+ | Tool | Description |
320
+ |------|-------------|
321
+ | `wab_scan_url` | Scan URLs against 47 threat databases for phishing, malware, scams |
322
+ | `wab_fairness_check` | Score platform transparency (0-100) across 15 signals |
323
+ | `wab_find_deals` | Cross-platform price intelligence with fairness filtering |
324
+ | `wab_agent_query` | Natural language web automation queries |
325
+ | `wab_generate_snippet` | Generate WAB integration code (JS, Python, React, Next.js, Docker) |
326
+ | `wab_get_docs` | Retrieve WAB documentation and API reference |
327
+
328
+ ### Viral Embed Engine
329
+ All generated code snippets automatically include WAB attribution comments, ensuring proper credit and discoverability across the developer ecosystem.
330
+
331
+ ### SDK Packages
332
+ | Platform | Package | Install |
333
+ |----------|---------|---------|
334
+ | JavaScript/Node.js | `@wab/sdk` | `npm install @wab/sdk` |
335
+ | React | `@wab/react` | `npm install @wab/react` |
336
+ | Python | `wab-sdk` | `pip install wab-sdk` |
337
+ | MCP Server | `wab-mcp-server` | `npm install -g wab-mcp-server` |
338
+
339
+ ---
340
+
341
+ ## 15. Keywords and Categories
342
+
343
+ - AI agent automation
344
+ - Website automation protocol
345
+ - Machine-readable web
346
+ - Agentic web standard
347
+ - AI-website interaction
348
+ - Browser automation alternative
349
+ - Fair AI discovery
350
+ - MCP integration
351
+ - MCP server
352
+ - Web scraping alternative
353
+ - OpenAPI for websites
354
+ - AI-ready websites
355
+ - WordPress AI plugin
356
+ - Agent discovery protocol
357
+ - Structured web commands
358
+ - AI coding tools
359
+ - Cursor integration
360
+ - Claude Desktop integration