hookdeck-cli 1.10.0-beta.1 → 1.10.0-beta.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.
- package/README.md +58 -10
- package/binaries/darwin-amd64/hookdeck +0 -0
- package/binaries/darwin-arm64/hookdeck +0 -0
- package/binaries/linux-amd64/hookdeck +0 -0
- package/binaries/linux-arm64/hookdeck +0 -0
- package/binaries/win32-386/hookdeck.exe +0 -0
- package/binaries/win32-amd64/hookdeck.exe +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -530,19 +530,24 @@ For complete command and flag reference, see [REFERENCE.md](REFERENCE.md).
|
|
|
530
530
|
|
|
531
531
|
### Event Gateway MCP
|
|
532
532
|
|
|
533
|
-
The CLI includes an [MCP](https://modelcontextprotocol.io/) (Model Context Protocol) server
|
|
533
|
+
The CLI includes an [MCP](https://modelcontextprotocol.io/) (Model Context Protocol) server for investigating event traffic in production. It exposes read-only tools that let AI agents query your Hookdeck Event Gateway — inspect connections, trace requests through events and delivery attempts, review issues, and pull aggregate metrics.
|
|
534
534
|
|
|
535
|
-
**
|
|
535
|
+
**Configure your MCP client** (Cursor, Claude Desktop, or any MCP-compatible host):
|
|
536
536
|
|
|
537
|
-
|
|
538
|
-
hookdeck gateway mcp
|
|
539
|
-
```
|
|
537
|
+
Cursor (`~/.cursor/mcp.json`):
|
|
540
538
|
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
539
|
+
```json
|
|
540
|
+
{
|
|
541
|
+
"mcpServers": {
|
|
542
|
+
"hookdeck": {
|
|
543
|
+
"command": "hookdeck",
|
|
544
|
+
"args": ["gateway", "mcp"]
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
}
|
|
548
|
+
```
|
|
544
549
|
|
|
545
|
-
|
|
550
|
+
Claude Desktop (`claude_desktop_config.json`):
|
|
546
551
|
|
|
547
552
|
```json
|
|
548
553
|
{
|
|
@@ -555,7 +560,50 @@ Add to your Cursor MCP settings (e.g. `~/.cursor/mcp.json` or project-level conf
|
|
|
555
560
|
}
|
|
556
561
|
```
|
|
557
562
|
|
|
558
|
-
|
|
563
|
+
The client starts `hookdeck gateway mcp` as a stdio subprocess. If you haven't authenticated yet, the `hookdeck_login` tool is available to log in via the browser.
|
|
564
|
+
|
|
565
|
+
#### Available tools
|
|
566
|
+
|
|
567
|
+
| Tool | Description |
|
|
568
|
+
|------|-------------|
|
|
569
|
+
| `hookdeck_projects` | List projects or switch the active project for this session |
|
|
570
|
+
| `hookdeck_connections` | Inspect connections and control delivery flow (list, get, pause, unpause) |
|
|
571
|
+
| `hookdeck_sources` | Inspect inbound sources (HTTP endpoints that receive events) |
|
|
572
|
+
| `hookdeck_destinations` | Inspect delivery destinations (HTTP endpoints where events are sent) |
|
|
573
|
+
| `hookdeck_transformations` | Inspect JavaScript transformations applied to event payloads |
|
|
574
|
+
| `hookdeck_requests` | Query inbound requests — list, get details, raw body, linked events |
|
|
575
|
+
| `hookdeck_events` | Query processed events — list, get details, raw payload body |
|
|
576
|
+
| `hookdeck_attempts` | Query delivery attempts — retry history, response codes, errors |
|
|
577
|
+
| `hookdeck_issues` | Inspect aggregated failure signals (delivery failures, transform errors, backpressure) |
|
|
578
|
+
| `hookdeck_metrics` | Query aggregate metrics — counts, failure rates, queue depth over time |
|
|
579
|
+
| `hookdeck_help` | Discover available tools and their actions |
|
|
580
|
+
|
|
581
|
+
#### Example prompts
|
|
582
|
+
|
|
583
|
+
Once the MCP server is configured, you can ask your agent questions like:
|
|
584
|
+
|
|
585
|
+
```
|
|
586
|
+
"Are any of my events failing right now?"
|
|
587
|
+
→ Agent uses hookdeck_issues to list open issues, then hookdeck_events to inspect recent failures.
|
|
588
|
+
|
|
589
|
+
"Show me the last 10 events for my Stripe source and check if any failed."
|
|
590
|
+
→ Agent uses hookdeck_sources to find the Stripe source, then hookdeck_events filtered by source and status.
|
|
591
|
+
|
|
592
|
+
"What's the error rate for my API destination over the last 24 hours?"
|
|
593
|
+
→ Agent uses hookdeck_metrics with measures like failed_count and count, grouped by destination.
|
|
594
|
+
|
|
595
|
+
"Trace request req_abc123 — what events did it produce, and did they all deliver successfully?"
|
|
596
|
+
→ Agent uses hookdeck_requests to get the request, then the events action to list generated events.
|
|
597
|
+
|
|
598
|
+
"Why is my checkout endpoint returning 500s? Show me the latest attempt details."
|
|
599
|
+
→ Agent uses hookdeck_events filtered by status FAILED, then hookdeck_attempts to inspect delivery details.
|
|
600
|
+
|
|
601
|
+
"Pause the connection between Stripe and my staging endpoint while I debug."
|
|
602
|
+
→ Agent uses hookdeck_connections to find and pause the connection.
|
|
603
|
+
|
|
604
|
+
"Compare failure rates across all my destinations this week."
|
|
605
|
+
→ Agent uses hookdeck_metrics with dimensions set to destination_id and measures like error_rate.
|
|
606
|
+
```
|
|
559
607
|
|
|
560
608
|
### Manage connections
|
|
561
609
|
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|