Skip to main content

agent-core-inbound

Deny-by-default inbound notifications router for agent-core beings. External signals (GitHub webhooks, Gmail messages, calendar events) flow through per-source connectors that classify each event as Allow{tier, reason} or Deny. The router de-dupes, rate-limits, delivers via the agent-core bus, and writes an audit log.

See docs/superpowers/specs/2026-06-20-inbound-notifications-design.md in the agent_core repo for the full design.

Bringing v1.a online (operator runbook)

1. Generate the GitHub webhook secret

Pick any high-entropy string; e.g.:

python -c "import secrets; print(secrets.token_urlsafe(32))"

Set it as an env var in the daemon's environment (e.g., your ~/.agent-core/.env or systemd unit):

FOREMAN_GITHUB_WEBHOOK_SECRET=<paste-here>

2. Write your allowance file

~/.<being>/.config/inbound/github-allowance.toml:

# Schema-flexible rule shape (v2).  See spec
# docs/superpowers/specs/2026-06-21-inbound-v2-schema-flexible-events-design.md
# for the full grammar.

[[allow]]
rule_id = "pr_review_requested_any_project"
event = "pull_request_review_requested"
match = { "requested_reviewer.login" = "<your-github-login>" }
tier = "red"
reason = "PR review requested on me"

[[allow]]
rule_id = "needs_help_foreman"
event = "issues_labeled"
repo = "<org>/<repo>"
match = { "label.name" = "foreman:needs-help" }
tier = "red"
reason = "Foreman escalation — needs operator unstick"

The reviewer/label_name shortcuts from v1.a still work — they translate to match entries automatically. body_contains was removed in v2 (raises ValueError on load); use exact-equality match instead, or wait for v2.1's match_contains operator.

Body projection. The GitHub connector trims the Notification envelope body to a small per-event-type field set (event type, action, repo, key identifiers). This keeps inline bus payloads under 1 KB and avoids bloating tool results with GitHub metadata your being doesn't need. The full raw webhook payload is always recoverable from GitHub's webhook delivery history via gh api repos/<repo>/hooks/<id>/deliveries/<delivery_id>.

The router watches the file's mtime and reloads on every webhook delivery — edit the TOML and the next event picks up the new rules without restarting the daemon.

3. Register the endpoint in agent_core.yaml

The inbound-notifications endpoint registers via the agent_core pluggy hook (see agent_core_inbound/plugin.py — the inbound.github type is registered automatically once the package is installed).

Add this entry to your agent_core.yaml's endpoints: list:

endpoints:
  - type: inbound.github
    name: inbound
    params:
      target_being: <your-being>
      listen_host: 127.0.0.1
      listen_port: 8765
      webhook_secret_env: FOREMAN_GITHUB_WEBHOOK_SECRET
      github_allowance_path: ~/.<being>/.config/inbound/github-allowance.toml
      audit_log_path: ~/.<being>/state/inbound-audit.jsonl
      rate_limit_per_minute: 30

The runner reads each entry's type and looks it up in the pluggy-registered endpoint types map. The name is the bus addressing name (also surfaces in agent-core ps). All params are passed as constructor kwargs to InboundEndpoint.

4. Start Tailscale Funnel

tailscale funnel 8765

Note the issued https://router.<tailnet>.ts.net URL.

5. Configure the GitHub webhook

In your repo settings → Webhooks → Add webhook:

  • Payload URL: https://router.<tailnet>.ts.net/github
  • Content type: application/json
  • Secret: the same value you stored in FOREMAN_GITHUB_WEBHOOK_SECRET
  • Which events: "Let me select individual events" — check Workflow runs, Pull requests, Pull request reviews, Issues, Issue comments, Pushes, Releases, Statuses. (Schema-flexible matching means we can add more later via gh api -X PATCH repos/<repo>/hooks/<id> -f events='[...]' with no daemon change.)

6. Smoke test

On any PR in your configured repo, request a review from @<your-github-login>. Within ~10s:

  • ~/.<being>/state/inbound-audit.jsonl gains an allow line with rule_id=pr_review_requested_any_project.
  • Your being's bus inbox receives a Notification envelope (urgency red).

If you instead see a deny line, double-check match = { "requested_reviewer.login" = "<your-github-login>" } in the allowance TOML against the actual reviewer GitHub login.

Troubleshooting

  • All POSTs land 401: the env var secret does not match the GitHub webhook secret. Re-paste both ends.
  • BusBootError: unknown endpoint type 'inbound.github': the agent-core-inbound package isn't installed in the daemon's environment, or its entry point isn't being discovered. Run uv sync (or your install path equivalent) and confirm python -c "import agent_core_inbound.plugin" succeeds.
  • Webhook delivers but no bus envelope: check the audit log first. If deny lines appear, the allowance rule isn't matching — verify the event, repo, and match dotted-path keys against the actual webhook payload (visible in GitHub's webhook delivery history).
  • No audit log writes at all: the endpoint isn't seeing the POST. Confirm Tailscale Funnel is active (tailscale funnel status) and the daemon log shows InboundEndpoint(name=inbound) started on 127.0.0.1:8765.
  • deny with reason="no_matching_rule" on every event: v2 parses every webhook event generically (no silent 204 fallback), so the connector denies anything not matched by an allow rule. If you expected an allow, the rule's event key (e.g. pull_request_opened) or match dotted-paths don't line up with the payload shape — check the webhook delivery body in GitHub's "Recent Deliveries" UI to confirm the exact field names.
  • Webhook deliveries land 404 from uvicorn: the Tailscale Funnel command should be tailscale funnel <port> — do NOT use --set-path=/github. That flag STRIPS the path prefix before forwarding, leaving uvicorn to see POST / (no route). The default mount at / is correct because the FastAPI route is at /github.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_core_inbound-0.8.2.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_core_inbound-0.8.2-py3-none-any.whl (23.2 kB view details)

Uploaded Python 3

File details

Details for the file agent_core_inbound-0.8.2.tar.gz.

File metadata

  • Download URL: agent_core_inbound-0.8.2.tar.gz
  • Upload date:
  • Size: 34.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for agent_core_inbound-0.8.2.tar.gz
Algorithm Hash digest
SHA256 ce662486ab5c62a623642190675eaa84e9f93f771432cc086411fbb8f67e5c65
MD5 6636f6eed3f0fd84d6096e8a381e4fe2
BLAKE2b-256 7220f45acafbc01ff4738147c435e6b5cd01eeb93d279cd6d56822bb4bfe09dd

See more details on using hashes here.

File details

Details for the file agent_core_inbound-0.8.2-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_core_inbound-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5b3d31646cbe7d33b5f46213848db627e58d1b1b9caa74bb1c8b602370cdd46f
MD5 04df6caf781555d633e4c17055e0d296
BLAKE2b-256 753920b84b0981f6381c9e0da119d03ab77b97e775e3d0ebac26eff46d83dca5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page