Skip to main content
Repo copy of this guide: docs/connectors/FULL_INTEGRATION_OVERVIEW.md, kept in sync with this page. This page is a map, not a replacement for the four deep-dive guides it links to.
A naming trap worth avoiding first: this codebase has two different things called “connector.” @parmana/connector-sdk is a generic library with reference mocks (SapConnector, OracleConnector, etc.) that never talk to a real system. The connectors the default server actually registers and runs in production — HubSpot, GitHub, Paytm, Slack — follow a different, simpler pattern documented in the Connector Development Guide. This page is about that second, real pattern.

The four pieces

They’re deliberately decoupled — that’s exactly why “got APPROVED” and “the action actually happened” are two separate, independently-verifiable claims (see Connect an Agent, Step 8).
  1. Write the policy firstWrite Your First Policy. Everything else needs the exact capability string and signalsSchema up front.
  2. Onboard a caller and test authorization with no connector yetConnect an Agent. A 500 (“no connector registered”) at this stage is expected — it confirms authorization works before execution is wired.
  3. Build the connectorConnector Development Guide.
  4. Add a SignalStateVerifier only if a caller lying about a signal is a real risk for this capability that a policy rule alone can’t catch.

What breaks if you skip a piece

Every row here is a real failure mode this codebase has actually hit and diagnosed, several the same night integrating a real refund-agent partner.

Next

Write Your First Policy

Author the policy that decides APPROVE/REJECT for your capability.

Connect an Agent

Onboard a caller with a scoped API key and test authorization end to end.

Connector Development Guide

Implement and register the connector that performs the real action.

Credential Isolation

How a connector receives a credential it never fetches itself.