Protocol SDK Index

This is the best entry page for the SDK docs.

Use it when you want the shortest path from “what is this?” to “how do I integrate?”

Recommended reading order

Start here

1. Vision and purpose
2. Protocol overview and exclusions
3. Protocol core concepts
4. Manifest and discovery

Connect and authenticate

• Partner quickstart
• App registration and tokens
• Consent and auth troubleshooting

Read and dispatch

• Read, connect, dispatch, and operate
• External actions reference
• Event subscriptions and replay
• Webhook consumer

Agents and production

• Agent integration paths
• Agent quickstart
• Agent readiness
• Agent toolset
• Delivery recovery

Production guidance

• Production readiness checklist
• Versioning and compatibility

Repository resources

Example scripts referenced throughout these docs live in:

• scripts/examples/protocol-partner-onboarding.mjs
• scripts/examples/protocol-partner-actions.mjs
• scripts/examples/protocol-webhook-consumer.mjs
• scripts/examples/protocol-partner-operations.mjs
• scripts/examples/protocol-partner-agent.mjs

The public docs describe the contract. The repository examples show how to use it.