Skip to content

README.md

Latest commit

 

History

History
89 lines (59 loc) · 4.28 KB

README.md

File metadata and controls

89 lines (59 loc) · 4.28 KB

Hookdeck Agent Skills

Equip your AI coding agent with webhook and event-driven architecture expertise. Receive, queue, route, and deliver webhooks with Hookdeck Event Gateway, test webhooks locally with the Hookdeck CLI, and build outbound webhook delivery with Hookdeck Outpost.

Install (Agent Skills / Other Agents)

For Claude, ChatGPT, and other agents that support the Agent Skills specification:

npx skills add hookdeck/agent-skills

Or install a specific skill:

npx skills add hookdeck/agent-skills --skill event-gateway
npx skills add hookdeck/agent-skills --skill outpost

Available Skills

Skill Purpose Use when...
hookdeck Skill router You need help with any Hookdeck product and aren't sure which skill to use
event-gateway Receive, route, and deliver webhooks Getting started with Hookdeck, receiving webhooks, configuring connections, local development, monitoring, or API automation
outpost Send webhooks to customers Sending events to customer endpoints via HTTP, SQS, RabbitMQ, Pub/Sub, or other destinations

You Say -> Skill Used

What you say Skill
"Set up Hookdeck for my project" event-gateway
"Receive webhooks from Stripe" event-gateway
"Test webhooks locally" event-gateway
"Filter events by type" event-gateway
"Why are my webhooks failing?" event-gateway
"Create a connection via the API" event-gateway
"Send webhooks to my users" outpost

Event Gateway Workflow

The event-gateway skill includes a staged integration workflow:

  1. Setup -- Create account, install CLI, create connection
  2. Scaffold -- Build webhook handler with verification code (for provider webhooks like Stripe or Shopify, use event-gateway together with the matching skill from webhook-skills)
  3. Listen -- Start hookdeck listen, trigger test events
  4. Iterate -- Debug failures, fix code, replay events

Hookdeck CLI MCP (reference)

The Hookdeck CLI includes a beta MCP server (hookdeck gateway mcp) that exposes Event Gateway data as MCP tools over stdio. In practice it is operational support: query, inspect, and diagnose connections, requests, events, attempts, issues, and metrics from your agent or IDE—without replacing the full CLI or API for creating resources, retries, or local tunnel workflows.

For setup, client configuration, available tools, and what MCP can and cannot do, see the official docs:

  • MCP & Skills — overview and when to pair MCP with agent skills
  • Hookdeck CLI — MCP is linked from the Event Gateway operations table (command usage, auth, client configuration)

The skills in this repository remain the primary way to guide an agent through product workflows (setup, handlers, hookdeck listen, Outpost, API usage). Use CLI MCP when you want read-heavy inspection and analysis against your live Hookdeck project.

Documentation

Testing

  • Code examples: Run ./scripts/test-examples.sh or see TESTING.md.
  • Agent scenarios: Run the scenario tester to verify an agent follows the event-gateway workflow. See TESTING.md.

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

Related

License

MIT