You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+66Lines changed: 66 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,49 @@ Using the Hookdeck CLI, you can forward your events (e.g. webhooks) to your loca
8
8
9
9
Hookdeck CLI is compatible with most of Hookdeck's features, such as filtering and fan-out delivery. You can use Hookdeck CLI to develop or test your event (e.g. webhook) integration code locally.
10
10
11
+
You can also manage Hookdeck Event Gateway resources—sources, destinations, connections, events, transformations—from the CLI. For AI and agent workflows, the Event Gateway MCP server (`hookdeck gateway mcp`) exposes these capabilities as tools in MCP-compatible clients (e.g. Cursor, Claude).
12
+
11
13
Although it uses a different approach and philosophy, it's a replacement for ngrok and alternative HTTP tunnel solutions.
12
14
13
15
Hookdeck for development is completely free, and we monetize the platform with our production offering.
14
16
15
17
For a complete reference of all commands and flags, see [REFERENCE.md](REFERENCE.md).
16
18
19
+
## Table of contents
20
+
21
+
-[Installation](#installation)
22
+
-[NPM](#npm)
23
+
-[macOS](#macos)
24
+
-[Windows](#windows)
25
+
-[Linux Or without package managers](#linux-or-without-package-managers)
26
+
-[Docker](#docker)
27
+
-[Usage](#usage)
28
+
-[Commands](#commands)
29
+
-[Login](#login)
30
+
-[Listen](#listen)
31
+
-[Logout](#logout)
32
+
-[Skip SSL validation](#skip-ssl-validation)
33
+
-[Disable health checks](#disable-health-checks)
34
+
-[Version](#version)
35
+
-[Completion](#completion)
36
+
-[Running in CI](#running-in-ci)
37
+
-[Event Gateway](#event-gateway)
38
+
-[Event Gateway MCP](#event-gateway-mcp)
39
+
-[Manage connections](#manage-connections)
40
+
-[Transformations](#transformations)
41
+
-[Requests, events, and attempts](#requests-events-and-attempts)
For complete command and flag reference, see [REFERENCE.md](REFERENCE.md).
493
530
531
+
### Event Gateway MCP
532
+
533
+
The CLI includes an [MCP](https://modelcontextprotocol.io/) (Model Context Protocol) server that exposes Hookdeck Event Gateway as tools for AI and agent workflows. Use it in MCP-compatible clients (e.g. Cursor, Claude) to list and inspect connections, sources, destinations, events, requests, attempts, issues, and metrics, and to run login from the host.
534
+
535
+
**Run the server (stdio):**
536
+
537
+
```sh
538
+
hookdeck gateway mcp
539
+
```
540
+
541
+
The server is intended to be configured as an MCP server in your client; it reads and writes JSON-RPC over stdin/stdout. Configure your client to run the above command as the server process.
542
+
543
+
**Example: Cursor MCP config**
544
+
545
+
Add to your Cursor MCP settings (e.g. `~/.cursor/mcp.json` or project-level config):
546
+
547
+
```json
548
+
{
549
+
"mcpServers": {
550
+
"hookdeck": {
551
+
"command": "hookdeck",
552
+
"args": ["gateway", "mcp"]
553
+
}
554
+
}
555
+
}
556
+
```
557
+
558
+
After configuration, the host can use tools such as `hookdeck_connections_list`, `hookdeck_events_list`, and `hookdeck_login` (when unauthenticated). For the full tool reference, see [REFERENCE.md](REFERENCE.md) or run `hookdeck gateway mcp --help`.
559
+
494
560
### Manage connections
495
561
496
562
Create and manage webhook connections between sources and destinations with inline resource creation, authentication, processing rules, and lifecycle management. Use `hookdeck gateway connection` (or the backward-compatible alias `hookdeck connection`). For detailed examples with authentication, filters, retry rules, and rate limiting, see the complete [connection management](#manage-connections) section below.
0 commit comments