Skip to content

Commit 2d8dd61

Browse files
committed
docs(mcp): use event-centric terminology instead of webhook-heavy language
Hookdeck is HTTP in, HTTP out — webhook events are one type of event trigger. Update tool descriptions and README to reflect this: - "webhook sources" → "inbound sources" - "webhook delivery destinations" → "delivery destinations" - "webhook payloads" → "event payloads" - "webhook connections" → "connections" - "webhook traffic" → "event traffic" - Use "webhook events" only where specifically about webhooks https://claude.ai/code/session_01Y2eJZgKG78nDyN6Uw2tWQx
1 parent 3fad452 commit 2d8dd61

3 files changed

Lines changed: 21 additions & 21 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -530,7 +530,7 @@ For complete command and flag reference, see [REFERENCE.md](REFERENCE.md).
530530

531531
### Event Gateway MCP
532532

533-
The CLI includes an [MCP](https://modelcontextprotocol.io/) (Model Context Protocol) server for investigating webhook 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.
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.
534534

535535
**Configure your MCP client** (Cursor, Claude Desktop, or any MCP-compatible host):
536536

@@ -568,9 +568,9 @@ The client starts `hookdeck gateway mcp` as a stdio subprocess. If you haven't a
568568
|------|-------------|
569569
| `hookdeck_projects` | List projects or switch the active project for this session |
570570
| `hookdeck_connections` | Inspect connections and control delivery flow (list, get, pause, unpause) |
571-
| `hookdeck_sources` | Inspect inbound webhook sources |
572-
| `hookdeck_destinations` | Inspect webhook delivery destinations |
573-
| `hookdeck_transformations` | Inspect JavaScript transformations applied to payloads |
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 |
574574
| `hookdeck_requests` | Query inbound requests — list, get details, raw body, linked events |
575575
| `hookdeck_events` | Query processed events — list, get details, raw payload body |
576576
| `hookdeck_attempts` | Query delivery attempts — retry history, response codes, errors |
@@ -583,7 +583,7 @@ The client starts `hookdeck gateway mcp` as a stdio subprocess. If you haven't a
583583
Once the MCP server is configured, you can ask your agent questions like:
584584

585585
```
586-
"Are any of my webhooks failing right now?"
586+
"Are any of my events failing right now?"
587587
→ Agent uses hookdeck_issues to list open issues, then hookdeck_events to inspect recent failures.
588588
589589
"Show me the last 10 events for my Stripe source and check if any failed."
@@ -595,7 +595,7 @@ Once the MCP server is configured, you can ask your agent questions like:
595595
"Trace request req_abc123 — what events did it produce, and did they all deliver successfully?"
596596
→ Agent uses hookdeck_requests to get the request, then the events action to list generated events.
597597
598-
"Why is my checkout webhook returning 500s? Show me the latest attempt details."
598+
"Why is my checkout endpoint returning 500s? Show me the latest attempt details."
599599
→ Agent uses hookdeck_events filtered by status FAILED, then hookdeck_attempts to inspect delivery details.
600600
601601
"Pause the connection between Stripe and my staging endpoint while I debug."

pkg/gateway/mcp/tool_help.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Current project: %s
3737
3838
hookdeck_projects — List or switch projects (actions: list, use)
3939
hookdeck_connections — Inspect connections and control delivery flow (actions: list, get, pause, unpause)
40-
hookdeck_sources — Inspect inbound webhook sources (actions: list, get)
41-
hookdeck_destinations — Inspect webhook delivery destinations (actions: list, get)
40+
hookdeck_sources — Inspect inbound sources (actions: list, get)
41+
hookdeck_destinations — Inspect delivery destinations (actions: list, get)
4242
hookdeck_transformations — Inspect JavaScript transformations (actions: list, get)
43-
hookdeck_requests — Query inbound webhook requests (actions: list, get, raw_body, events, ignored_events)
44-
hookdeck_events — Query processed webhook events (actions: list, get, raw_body)
43+
hookdeck_requests — Query inbound requests (actions: list, get, raw_body, events, ignored_events)
44+
hookdeck_events — Query processed events (actions: list, get, raw_body)
4545
hookdeck_attempts — Query delivery attempts (actions: list, get)
4646
hookdeck_issues — Inspect aggregated failure signals (actions: list, get)
4747
hookdeck_metrics — Query aggregate metrics (actions: events, requests, attempts, transformations)
@@ -81,7 +81,7 @@ Parameters:
8181
limit (integer) — Max results (list, default 100)
8282
next/prev (string) — Pagination cursors (list)`,
8383

84-
"hookdeck_sources": `hookdeck_sources — Inspect inbound webhook sources
84+
"hookdeck_sources": `hookdeck_sources — Inspect inbound sources
8585
8686
Actions:
8787
list — List sources with optional filters
@@ -94,7 +94,7 @@ Parameters:
9494
limit (integer) — Max results (list, default 100)
9595
next/prev (string) — Pagination cursors (list)`,
9696

97-
"hookdeck_destinations": `hookdeck_destinations — Inspect webhook delivery destinations
97+
"hookdeck_destinations": `hookdeck_destinations — Inspect delivery destinations
9898
9999
Actions:
100100
list — List destinations with optional filters
@@ -120,7 +120,7 @@ Parameters:
120120
limit (integer) — Max results (list, default 100)
121121
next/prev (string) — Pagination cursors (list)`,
122122

123-
"hookdeck_requests": `hookdeck_requests — Query inbound webhook requests
123+
"hookdeck_requests": `hookdeck_requests — Query inbound requests
124124
125125
Actions:
126126
list — List requests with optional filters
@@ -139,7 +139,7 @@ Parameters:
139139
limit (integer) — Max results (list, default 100)
140140
next/prev (string) — Pagination cursors (list)`,
141141

142-
"hookdeck_events": `hookdeck_events — Query events (processed webhook deliveries)
142+
"hookdeck_events": `hookdeck_events — Query events (processed deliveries)
143143
144144
Actions:
145145
list — List events with optional filters

pkg/gateway/mcp/tools.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func toolDefs(client *hookdeck.Client) []struct {
3333
{
3434
tool: &mcpsdk.Tool{
3535
Name: "hookdeck_connections",
36-
Description: "Inspect webhook connections (routes linking sources to destinations). List connections with filters, get details by ID, or pause/unpause a connection's delivery pipeline.",
36+
Description: "Inspect connections (routes linking sources to destinations). List connections with filters, get details by ID, or pause/unpause a connection's delivery pipeline.",
3737
InputSchema: schema(map[string]prop{
3838
"action": {Type: "string", Desc: "Action: list, get, pause, or unpause", Enum: []string{"list", "get", "pause", "unpause"}},
3939
"id": {Type: "string", Desc: "Connection ID (required for get/pause/unpause)"},
@@ -51,7 +51,7 @@ func toolDefs(client *hookdeck.Client) []struct {
5151
{
5252
tool: &mcpsdk.Tool{
5353
Name: "hookdeck_sources",
54-
Description: "List and inspect inbound webhook sources. Returns source configuration including URL, verification settings, and allowed HTTP methods.",
54+
Description: "List and inspect inbound sources (HTTP endpoints that receive events). Returns source configuration including URL, verification settings, and allowed HTTP methods.",
5555
InputSchema: schema(map[string]prop{
5656
"action": {Type: "string", Desc: "Action: list or get", Enum: []string{"list", "get"}},
5757
"id": {Type: "string", Desc: "Source ID (required for get)"},
@@ -66,7 +66,7 @@ func toolDefs(client *hookdeck.Client) []struct {
6666
{
6767
tool: &mcpsdk.Tool{
6868
Name: "hookdeck_destinations",
69-
Description: "List and inspect webhook delivery destinations. Returns destination configuration including URL, authentication, and rate limiting settings.",
69+
Description: "List and inspect delivery destinations (HTTP endpoints where events are sent). Returns destination configuration including URL, authentication, and rate limiting settings.",
7070
InputSchema: schema(map[string]prop{
7171
"action": {Type: "string", Desc: "Action: list or get", Enum: []string{"list", "get"}},
7272
"id": {Type: "string", Desc: "Destination ID (required for get)"},
@@ -81,7 +81,7 @@ func toolDefs(client *hookdeck.Client) []struct {
8181
{
8282
tool: &mcpsdk.Tool{
8383
Name: "hookdeck_transformations",
84-
Description: "List and inspect JavaScript transformations applied to webhook payloads. Returns transformation code and configuration for debugging payload processing.",
84+
Description: "List and inspect JavaScript transformations applied to event payloads. Returns transformation code and configuration for debugging payload processing.",
8585
InputSchema: schema(map[string]prop{
8686
"action": {Type: "string", Desc: "Action: list or get", Enum: []string{"list", "get"}},
8787
"id": {Type: "string", Desc: "Transformation ID (required for get)"},
@@ -96,7 +96,7 @@ func toolDefs(client *hookdeck.Client) []struct {
9696
{
9797
tool: &mcpsdk.Tool{
9898
Name: "hookdeck_requests",
99-
Description: "Query inbound webhook requests (raw data received by Hookdeck before routing). List with filters, get details, inspect the raw body, or view the events and ignored events generated from a request.",
99+
Description: "Query inbound requests (raw HTTP data received by Hookdeck before routing). List with filters, get details, inspect the raw body, or view the events and ignored events generated from a request.",
100100
InputSchema: schema(map[string]prop{
101101
"action": {Type: "string", Desc: "Action: list, get, raw_body, events, or ignored_events", Enum: []string{"list", "get", "raw_body", "events", "ignored_events"}},
102102
"id": {Type: "string", Desc: "Request ID (required for get/raw_body/events/ignored_events)"},
@@ -114,7 +114,7 @@ func toolDefs(client *hookdeck.Client) []struct {
114114
{
115115
tool: &mcpsdk.Tool{
116116
Name: "hookdeck_events",
117-
Description: "Query events (webhook deliveries routed through connections). List with filters by status, source, destination, or date range. Get event details or inspect the raw payload body.",
117+
Description: "Query events (processed deliveries routed through connections to destinations). List with filters by status, source, destination, or date range. Get event details or inspect the raw payload body.",
118118
InputSchema: schema(map[string]prop{
119119
"action": {Type: "string", Desc: "Action: list, get, or raw_body", Enum: []string{"list", "get", "raw_body"}},
120120
"id": {Type: "string", Desc: "Event ID (required for get/raw_body)"},
@@ -156,7 +156,7 @@ func toolDefs(client *hookdeck.Client) []struct {
156156
{
157157
tool: &mcpsdk.Tool{
158158
Name: "hookdeck_issues",
159-
Description: "List and inspect Hookdeck issues — aggregated failure signals such as repeated delivery failures, transformation errors, and backpressure alerts. Use this to identify systemic problems across your webhooks.",
159+
Description: "List and inspect Hookdeck issues — aggregated failure signals such as repeated delivery failures, transformation errors, and backpressure alerts. Use this to identify systemic problems across your event pipeline.",
160160
InputSchema: schema(map[string]prop{
161161
"action": {Type: "string", Desc: "Action: list or get", Enum: []string{"list", "get"}},
162162
"id": {Type: "string", Desc: "Issue ID (required for get)"},

0 commit comments

Comments
 (0)