@orkestrate/agent-webmcp 0.2.0 → 0.2.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 +148 -0
  2. package/package.json +23 -9
  3. package/bin/check.js +0 -23
package/README.md ADDED
@@ -0,0 +1,148 @@
1
+ <p align="center">
2
+ <img src="https://raw.githubusercontent.com/orkestrate-dot-space/agent-webmcp/main/.github/assets/banner.png" alt="agent-webmcp: tools for every site your agent visits" width="100%">
3
+ </p>
4
+
5
+ <p align="center">
6
+ <a href="https://www.npmjs.com/package/@orkestrate/agent-webmcp"><img src="https://img.shields.io/npm/v/@orkestrate/agent-webmcp?color=000&label=npm" alt="npm version"></a>
7
+ <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-000" alt="MIT license"></a>
8
+ <a href="https://web.orkestrate.space/webmcp/sites"><img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fagent-webmcp-index.agent-webmcp.workers.dev%2Findex.json&query=%24.sites&suffix=%20sites&label=directory&color=000" alt="Sites in the directory"></a>
9
+ </p>
10
+
11
+ # agent-webmcp
12
+
13
+ Your agent is clicking through pages that already have typed tools.
14
+ agent-webmcp tells it which ones before it opens them.
15
+
16
+ Sites can now register [WebMCP](https://github.com/webmachinelearning/webmcp)
17
+ tools: named functions with a description and an input schema, callable from
18
+ the page. An agent that calls `searchFlights({origin, destination, ...})`
19
+ skips the screenshots, the guessed selectors and the retries. The catch is
20
+ that nothing tells the agent which sites have tools, so it drives the page
21
+ by hand anyway.
22
+
23
+ agent-webmcp is that missing lookup. One call, before the agent opens a
24
+ page:
25
+
26
+ ```console
27
+ $ agent-webmcp find "search flights"
28
+ googlechromelabs.github.io/searchFlights [unspecified]
29
+ Searches for flights with the given parameters.
30
+ open https://googlechromelabs.github.io/webmcp-tools/demos/react-flightsearch/
31
+ ```
32
+
33
+ | Without agent-webmcp | With agent-webmcp |
34
+ |---|---|
35
+ | Open the page, snapshot, find the form, type into each field, click search, snapshot again to check | `find` names the page and tool, open it, call `searchFlights` once with typed arguments |
36
+ | Breaks when the layout changes | Calls the interface the site publishes for agents |
37
+ | Never learns the site had a tool | Knows before the page loads |
38
+
39
+ It works with the browser driver you already use: agent-browser, Playwright
40
+ MCP, Chrome DevTools MCP or OpenCode Browse. agent-webmcp never opens pages
41
+ or calls tools itself; your driver does. When nothing matches, `find` says
42
+ so, and the agent uses its driver as usual.
43
+
44
+ ## Quickstart
45
+
46
+ Install one of two ways:
47
+
48
+ | | |
49
+ |---|---|
50
+ | curl (Linux, macOS) | `curl -fsSL https://github.com/orkestrate-dot-space/agent-webmcp/releases/latest/download/install.sh \| sh` |
51
+ | npm (any OS) | `npm i -g @orkestrate/agent-webmcp` |
52
+
53
+ Then run first-run setup:
54
+
55
+ ```console
56
+ $ agent-webmcp setup
57
+ ```
58
+
59
+ The curl script installs one checksum-verified binary to `~/.local/bin`
60
+ and never edits your shell profile; it tells you if that folder is not on
61
+ your PATH. Both installs upgrade with `agent-webmcp upgrade`.
62
+
63
+ `setup` downloads the index, installs the agent skill (Claude Code, OpenCode
64
+ and any `~/.agents` client), adds the MCP server to OpenCode, and prints
65
+ one-line installs for Claude Code and Codex:
66
+
67
+ ```console
68
+ $ claude mcp add agent-webmcp -s user -- agent-webmcp mcp
69
+ $ codex mcp add agent-webmcp -- agent-webmcp mcp
70
+ ```
71
+
72
+ Some drivers need a flag to turn WebMCP on. [docs/drivers.md](docs/drivers.md)
73
+ has the setup for each one, checked on 18 Nov 2026.
74
+
75
+ Or skip all of this: the **Copy prompt** button on
76
+ [web.orkestrate.space/webmcp](https://web.orkestrate.space/webmcp) gives your
77
+ agent a prompt that installs and checks everything itself.
78
+
79
+ ## Check a site, a URL or a task
80
+
81
+ ```console
82
+ $ agent-webmcp find cal.com
83
+ cal.com/ask_cal_com [unspecified]
84
+ Ask a question about Cal.com (plans, features, integrations, self-hosting, the API) and get an answer grounded in the documentation.
85
+ open https://cal.com/
86
+
87
+ $ agent-webmcp find stripe.com
88
+ No indexed site has a tool for "stripe.com". Use your browser driver as usual.
89
+ ```
90
+
91
+ Site lookup is the main use: your agent already knows where it is going.
92
+ Task search covers the sites in the index. Add `--json` for each tool's
93
+ input schema.
94
+
95
+ ## The directory
96
+
97
+ Every indexed site and its tools are listed at
98
+ [web.orkestrate.space/webmcp/sites](https://web.orkestrate.space/webmcp/sites).
99
+ A bot rechecks every site weekly in a fresh Chromium, so listings reflect
100
+ what pages register today.
101
+
102
+ **Own a site with WebMCP tools?** Paste its URL into **Add your site**. The
103
+ bot checks it and lists it within a couple of minutes, with no account or
104
+ ownership proof needed. [CONTRIBUTING.md](CONTRIBUTING.md) has the rules.
105
+ Owners can ask for removal at support@orkestrate.space.
106
+
107
+ ## Commands
108
+
109
+ | Command | What it does |
110
+ |---|---|
111
+ | `find <site, URL or task>` | Check a site first, or search by task. `--json` for machine output. |
112
+ | `setup` | First run: index, skill, MCP wiring, driver notes. |
113
+ | `mcp` | Run an MCP server with one tool, `find`. |
114
+ | `update` | Check for a newer index now (it also checks hourly). |
115
+ | `upgrade [version]` | Upgrade agent-webmcp itself the way you installed it (latest by default). |
116
+ | `status` | Show the index in use and where it came from. |
117
+
118
+ How matching, listing and index updates work: [docs/index.md](docs/index.md).
119
+
120
+ ## Next
121
+
122
+ Planned for 0.3, not shipped yet:
123
+
124
+ - **`call`**: open the page and call a site's tool in one command, from the
125
+ CLI or the MCP server. Tools marked consequential will need explicit
126
+ confirmation.
127
+ - **Registry**: `agent-webmcp add` for reviewed, versioned items, pinned in a
128
+ lockfile and kept current with `outdated` and `update`.
129
+
130
+ Watch the repo or follow the [changelog](CHANGELOG.md) to hear when they land.
131
+
132
+ ## Privacy
133
+
134
+ No analytics. The CLI fetches only the public index (hourly, or on demand
135
+ with `update`), and the index server stores nothing about who reads it. Site
136
+ submissions keep the submitted URL and a salted hash of the submitter's IP
137
+ for rate limiting.
138
+
139
+ ## Contributing
140
+
141
+ Build from source with `cargo build --release`; the result is the same
142
+ binary npm ships. Bugs go in [issues](https://github.com/orkestrate-dot-space/agent-webmcp/issues),
143
+ security reports to [SECURITY.md](SECURITY.md). v1 is preserved on the
144
+ `archive/v1-main` branch.
145
+
146
+ ## License
147
+
148
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orkestrate/agent-webmcp",
3
- "version": "0.2.0",
3
+ "version": "0.2.2",
4
4
  "description": "Check whether a site offers WebMCP tools before you open it, then use them with the browser driver you already use.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://github.com/orkestrate-dot-space/agent-webmcp#readme",
@@ -12,15 +12,29 @@
12
12
  "bin": {
13
13
  "agent-webmcp": "bin/agent-webmcp.js"
14
14
  },
15
- "files": ["bin"],
15
+ "files": [
16
+ "bin",
17
+ "README.md"
18
+ ],
16
19
  "optionalDependencies": {
17
- "@orkestrate/agent-webmcp-linux-x64": "0.2.0",
18
- "@orkestrate/agent-webmcp-linux-arm64": "0.2.0",
19
- "@orkestrate/agent-webmcp-darwin-arm64": "0.2.0",
20
- "@orkestrate/agent-webmcp-darwin-x64": "0.2.0",
21
- "@orkestrate/agent-webmcp-win32-x64": "0.2.0"
20
+ "@orkestrate/agent-webmcp-linux-x64": "0.2.2",
21
+ "@orkestrate/agent-webmcp-linux-arm64": "0.2.2",
22
+ "@orkestrate/agent-webmcp-darwin-arm64": "0.2.2",
23
+ "@orkestrate/agent-webmcp-darwin-x64": "0.2.2",
24
+ "@orkestrate/agent-webmcp-win32-x64": "0.2.2"
22
25
  },
23
- "scripts": {
24
- "postinstall": "node bin/check.js"
26
+ "engines": {
27
+ "node": ">=18"
28
+ },
29
+ "keywords": [
30
+ "webmcp",
31
+ "mcp",
32
+ "model-context-protocol",
33
+ "ai-agents",
34
+ "browser-automation",
35
+ "cli"
36
+ ],
37
+ "bugs": {
38
+ "url": "https://github.com/orkestrate-dot-space/agent-webmcp/issues"
25
39
  }
26
40
  }
package/bin/check.js DELETED
@@ -1,23 +0,0 @@
1
- #!/usr/bin/env node
2
- // Postinstall: fail loudly when no platform binary landed, so `agent-webmcp`
3
- // never silently does nothing.
4
- import { createRequire } from "node:module";
5
-
6
- const pkgs = {
7
- "linux-x64": "@orkestrate/agent-webmcp-linux-x64",
8
- "linux-arm64": "@orkestrate/agent-webmcp-linux-arm64",
9
- "darwin-arm64": "@orkestrate/agent-webmcp-darwin-arm64",
10
- "darwin-x64": "@orkestrate/agent-webmcp-darwin-x64",
11
- "win32-x64": "@orkestrate/agent-webmcp-win32-x64",
12
- };
13
- const name = pkgs[`${process.platform}-${process.arch}`];
14
- if (!name) {
15
- console.warn(`agent-webmcp: no binary for ${process.platform}-${process.arch}; this platform is untested`);
16
- process.exit(0);
17
- }
18
- try {
19
- createRequire(import.meta.url).resolve(`${name}/package.json`);
20
- } catch {
21
- console.error(`agent-webmcp: ${name} did not install. Check your npm optional-dependency settings and reinstall.`);
22
- process.exit(1);
23
- }