@openweb-dev/mcp-server 0.1.2

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 (3) hide show
  1. package/README.md +105 -0
  2. package/dist/index.js +146393 -0
  3. package/package.json +62 -0
package/README.md ADDED
@@ -0,0 +1,105 @@
1
+ # @openweb-dev/mcp-server
2
+
3
+ MCP server for [OpenWeb](https://github.com/songzeli/openweb) — the booking-grade reliability layer for AI agents.
4
+
5
+ Adds tools to your AI assistant (Claude Desktop, Cursor, etc.) for completing real bookings on the open web: restaurant reservations, event registrations, clinic appointments. Recipe-replay engine + unattended SMS verification via Twilio. ~95% reliability at ~$0.03/booking on validated platforms (SevenRooms, Eventbrite, Lu.ma, Solv, Resy).
6
+
7
+ ## Two ways to use it
8
+
9
+ | | Free (local) | Paid (hosted brain) |
10
+ |---|---|---|
11
+ | **Install** | `git clone` + `docker-compose up` + Anthropic key | `npx @openweb-dev/mcp-server` + 2 env vars |
12
+ | **Pays** | Your own Anthropic spend | Per-call to brain operator |
13
+ | **Recipes** | Private to your machine | Shared corpus across paid-tier customers |
14
+ | **Setup time** | ~5 min | ~30 seconds |
15
+
16
+ ## Quickstart — hosted brain (recommended for non-developers)
17
+
18
+ Get a brain key from the maintainer (DM the issue or post in discussions), then add this to your Claude Desktop config:
19
+
20
+ `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) / `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
21
+
22
+ ```jsonc
23
+ {
24
+ "mcpServers": {
25
+ "webmcp": {
26
+ "command": "npx",
27
+ "args": ["-y", "@openweb-dev/mcp-server"],
28
+ "env": {
29
+ "OPENWEB_BRAIN_URL": "https://webmcp-brain.fly.dev",
30
+ "OPENWEB_BRAIN_KEY": "sk_live_…",
31
+ "OPENWEB_PROFILE_PATH": "/abs/path/to/.profile"
32
+ }
33
+ }
34
+ }
35
+ }
36
+ ```
37
+
38
+ Restart Claude Desktop. OpenWeb's tools (`book`, `provide_input`) are now available — try asking Claude to book a restaurant or RSVP to an event.
39
+
40
+ `OPENWEB_PROFILE_PATH` points at a JSON file with your contact info (first name, last name, email, phone, ...). See the [main repo's `.profile.example`](https://github.com/songzeli/openweb/blob/main/.profile.example) for the shape.
41
+
42
+ ## Quickstart — local self-host (for developers, free)
43
+
44
+ ```bash
45
+ git clone https://github.com/songzeli/openweb
46
+ cd openweb
47
+ docker-compose up -d postgres
48
+ echo "ANTHROPIC_API_KEY=sk-ant-..." > .env
49
+ pnpm install && pnpm -r build
50
+ pnpm migrate
51
+ ```
52
+
53
+ Then point Claude Desktop config at the local-built MCP server:
54
+
55
+ ```jsonc
56
+ {
57
+ "mcpServers": {
58
+ "webmcp": {
59
+ "command": "node",
60
+ "args": ["/abs/path/to/openweb/packages/mcp-server/dist/index.js"],
61
+ "env": {
62
+ "DATABASE_URL": "postgresql://webmcp:webmcp_dev@localhost:5432/webmcp",
63
+ "ANTHROPIC_API_KEY": "sk-ant-…",
64
+ "OPENWEB_PROFILE_PATH": "/abs/path/to/.profile"
65
+ }
66
+ }
67
+ }
68
+ }
69
+ ```
70
+
71
+ Same MCP tools available; everything runs on your machine; nothing leaves your network.
72
+
73
+ ## What this MCP server exposes
74
+
75
+ | Tool | What it does |
76
+ |---|---|
77
+ | `book` | Submit a booking task. The engine reads your profile, navigates the site, fills the form, handles verification (SMS via Twilio if configured), and submits. Returns booking ID + status. |
78
+ | `provide_input` | Resume a paused booking with user-supplied data (e.g. an OTP code if Twilio auto-resolution isn't set up). |
79
+ | `discover` | Search OpenWeb's knowledge base for sites/platforms it knows. |
80
+
81
+ See the [main repo](https://github.com/songzeli/openweb) for the full feature catalog: 5 validated platforms, ~40 named failure modes each with a shipped fix, 870+ unit tests.
82
+
83
+ ## Architecture (one diagram)
84
+
85
+ ```
86
+ Claude Desktop ──► @openweb-dev/mcp-server (this package, runs on YOUR machine)
87
+
88
+
89
+ @openweb-dev/engine (bundled in)
90
+
91
+ ┌───────────┴───────────┐
92
+ ▼ ▼
93
+ local Chromium https://webmcp-brain.fly.dev
94
+ (Playwright) (LLM + recipe corpus)
95
+ [only if OPENWEB_BRAIN_URL set]
96
+ ```
97
+
98
+ The MCP server runs as a local subprocess on your machine. Web browsing happens locally via Playwright. LLM calls go either to your own Anthropic key (free local mode) or to the hosted brain (paid mode, set via 2 env vars).
99
+
100
+ ## Links
101
+
102
+ - **Repo / source / issues**: https://github.com/songzeli/openweb
103
+ - **Strategy + roadmap**: https://github.com/songzeli/openweb/blob/main/docs/PLAN.md
104
+ - **Closed-gap catalog (the moat)**: https://github.com/songzeli/openweb/blob/main/docs/archive/CLOSED_GAPS.md
105
+ - **License**: MIT