-
Notifications
You must be signed in to change notification settings - Fork 483
Expand file tree
/
Copy pathdata.ts
More file actions
2343 lines (2032 loc) · 91.1 KB
/
Copy pathdata.ts
File metadata and controls
2343 lines (2032 loc) · 91.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {
type ConnectionIdentity,
type IntegrationEntry,
channelEntries,
connectionEntries,
connectionProtocols as protocolsForIdentity,
extensionEntries,
instrumentationEntries,
} from "@eve/catalog";
import type { LogoKey } from "./logos";
/**
* The docs integration gallery layers presentation (logo, keywords, setup
* markdown, auth modes) on top of the shared identity catalog
* (`@eve/catalog`). Identity — slug, name, kind, tagline, and a
* connection's transport + model-facing description — comes from the catalog
* and is never re-declared here; this module owns only the docs-facing overlay,
* keyed by slug.
*/
export type IntegrationType = "channel" | "connection" | "extension" | "instrumentation";
/** Wire protocol and transport identity types are owned by the shared catalog. */
export type { ConnectionProtocol, McpTransport, OpenApiTransport } from "@eve/catalog";
import type { ConnectionProtocol } from "@eve/catalog";
/**
* How a connection authenticates. A mode uses either Vercel Connect (`user`,
* `app`, or `jwtBearer`) or a server-side API key.
*/
export type AuthMode = "user" | "app" | "jwtBearer" | "apiKey";
export interface ApiKeySpec {
/** Server-side environment variable containing the API key. */
env: string;
/** Header used to send the API key. */
header: string;
}
/**
* Structured description of a connection consumed by the detail page to
* generate Install, Quick start, and Configure content. Transport (`mcp`,
* `openapi`) and `description` are filled from the shared catalog identity;
* Auth modes, connectors, and configure notes are the docs-only overlay.
*/
export interface ConnectionSpec {
/** Vercel Connect connector UID; defaults to the integration slug. */
connector?: string;
/** Auth-mode-specific connector UIDs when one service needs separate connectors. */
connectors?: Partial<Record<AuthMode, string>>;
/** Service passed to `vercel connect create` when it differs from the connector UID. */
connectorService?: string;
/** Auth-mode-specific services passed to `vercel connect create`. */
connectorServices?: Partial<Record<AuthMode, string>>;
/** Supported auth modes in display order; the first is the default. */
authModes: AuthMode[];
/** API-key wiring when `authModes` includes `apiKey`. */
apiKey?: ApiKeySpec;
/** Model-facing description; defaults to the integration tagline. */
description?: string;
mcp?: ConnectionIdentity["mcp"];
openapi?: ConnectionIdentity["openapi"];
/** Optional provider-specific configure guidance, rendered as markdown. */
configureNote?: string;
/** Auth-mode-specific configure guidance, rendered as markdown. */
configureNotes?: Partial<Record<AuthMode, string>>;
}
export interface Integration {
/** URL slug and lookup key, derived once and reused everywhere. */
slug: string;
name: string;
type: IntegrationType;
/** Protocol badges shown on the gallery card (connections only). */
protocols?: ConnectionProtocol[];
/** One-line summary shown on the gallery card. */
tagline: string;
/** Brand logo key from `lib/integrations/logos`. */
logo: LogoKey;
/** Optional pill (e.g. "Chat SDK") shown next to the type label. */
badge?: string;
/** Canonical reference doc for deeper details. */
docsHref: string;
/** Searchable keywords beyond the name. */
keywords?: string[];
/**
* Channels and extensions author their setup as markdown. Connections leave
* these unset and supply a `connection` spec, from which content is generated.
*/
install?: string;
quickStart?: string;
configure?: string;
/** Structured connection spec; present only for `type: "connection"`. */
connection?: ConnectionSpec;
}
/** Docs presentation overlay shared by every integration kind. */
interface Presentation {
logo: LogoKey;
docsHref: string;
keywords?: string[];
/** Optional gallery pill (e.g. "Chat SDK") shown next to the type label. */
badge?: string;
}
/** Channel overlay: presentation plus hand-authored setup markdown. */
interface ChannelPresentation extends Presentation {
install: string;
quickStart: string;
configure: string;
}
/** Extension overlay with hand-authored package setup. */
interface ExtensionPresentation extends Presentation {
install: string;
quickStart: string;
configure: string;
}
/** Connection overlay: presentation plus Connect auth/config details. */
interface ConnectionPresentation extends Presentation {
authModes: AuthMode[];
apiKey?: ApiKeySpec;
connector?: string;
connectors?: Partial<Record<AuthMode, string>>;
connectorService?: string;
connectorServices?: Partial<Record<AuthMode, string>>;
configureNote?: string;
configureNotes?: Partial<Record<AuthMode, string>>;
}
const channelPresentations: Record<string, ChannelPresentation> = {
slack: {
logo: "slack",
docsHref: "/docs/channels/slack",
keywords: ["chat", "messaging", "bot", "webhook"],
install: `The eve CLI scaffolds the channel for you. \`eve add channel/slack\` writes \`agent/channels/slack.ts\`, adds \`@vercel/connect\`, and runs the Connect setup flow:
\`\`\`bash
eve add channel/slack
\`\`\`
To wire it up by hand instead, install the framework and the Connect SDK. Slack channels use [Vercel Connect](https://vercel.com/docs/connect) for both the outbound bot token and inbound webhook verification:
\`\`\`bash
npm install eve@latest @vercel/connect
\`\`\``,
quickStart: `Create \`agent/channels/slack.ts\`. The channel name is derived from the filename, so no \`name\` field is needed:
\`\`\`ts
// agent/channels/slack.ts
import { slackChannel } from "eve/channels/slack";
import { connectSlackCredentials } from "@vercel/connect/eve";
export default slackChannel({
credentials: connectSlackCredentials("slack/my-agent"),
});
\`\`\`
Link the project and pull OIDC env vars so Connect can authenticate locally:
\`\`\`bash
vercel link
vercel env pull
\`\`\``,
configure: `Create a Slack Connect client and copy its UID (for example \`slack/my-agent\`), then attach this project as the webhook trigger destination at the route eve serves (\`/eve/v1/slack\`):
\`\`\`bash
vercel connect create slack --triggers
\`\`\`
The channel handles mentions, DMs, typing indicators, delivery, and human-in-the-loop consent with sensible defaults. See the [Slack channel docs](/docs/channels/slack) for customizing each behavior.`,
},
discord: {
logo: "discord",
docsHref: "/docs/channels/discord",
keywords: ["chat", "messaging", "bot", "guild"],
install: `Add this channel from eve's registry. This writes \`agent/channels/discord.ts\`:
\`\`\`bash
eve add channel/discord
\`\`\``,
quickStart: `Create \`agent/channels/discord.ts\`:
\`\`\`ts
// agent/channels/discord.ts
import { discordChannel } from "eve/channels/discord";
export default discordChannel({
credentials: {
botToken: () => process.env.DISCORD_BOT_TOKEN!,
publicKey: () => process.env.DISCORD_PUBLIC_KEY!,
},
});
\`\`\``,
configure: `Create a Discord application, add a bot, and set the interactions endpoint URL to the route eve serves (\`/eve/v1/discord\`). Provide the bot token and public key through environment variables. See the [Discord channel docs](/docs/channels/discord) for intents and slash-command setup.`,
},
teams: {
logo: "teams",
docsHref: "/docs/channels/teams",
keywords: ["chat", "messaging", "bot", "microsoft"],
install: `Add this channel from eve's registry. This writes \`agent/channels/teams.ts\`:
\`\`\`bash
eve add channel/teams
\`\`\``,
quickStart: `Create \`agent/channels/teams.ts\`:
\`\`\`ts
// agent/channels/teams.ts
import { teamsChannel } from "eve/channels/teams";
export default teamsChannel({
credentials: {
appId: () => process.env.TEAMS_APP_ID!,
appPassword: () => process.env.TEAMS_APP_PASSWORD!,
},
});
\`\`\``,
configure: `Register an Azure Bot, configure the messaging endpoint to eve's route (\`/eve/v1/teams\`), and supply the app ID and password via environment variables. See the [Teams channel docs](/docs/channels/teams) for the full provisioning checklist.`,
},
telegram: {
logo: "telegram",
docsHref: "/docs/channels/telegram",
keywords: ["chat", "messaging", "bot"],
install: `Add this channel from eve's registry. This writes \`agent/channels/telegram.ts\`:
\`\`\`bash
eve add channel/telegram
\`\`\``,
quickStart: `Create \`agent/channels/telegram.ts\`:
\`\`\`ts
// agent/channels/telegram.ts
import { telegramChannel } from "eve/channels/telegram";
export default telegramChannel({
credentials: { botToken: () => process.env.TELEGRAM_BOT_TOKEN! },
});
\`\`\``,
configure: `Create a bot with [@BotFather](https://t.me/botfather), then register the webhook to point at eve's route (\`/eve/v1/telegram\`). Store the bot token in an environment variable. See the [Telegram channel docs](/docs/channels/telegram) for group privacy and command setup.`,
},
twilio: {
logo: "twilio",
docsHref: "/docs/channels/twilio",
keywords: ["sms", "voice", "calls", "phone", "transcription"],
install: `Add this channel from eve's registry. This writes \`agent/channels/twilio.ts\`:
\`\`\`bash
eve add channel/twilio
\`\`\``,
quickStart: `Create \`agent/channels/twilio.ts\`. \`allowFrom\` is required and gates who can reach the inbound hooks:
\`\`\`ts
// agent/channels/twilio.ts
import { twilioChannel } from "eve/channels/twilio";
export default twilioChannel({
allowFrom: "+15551234567",
messaging: { from: "+15557654321" },
});
\`\`\`
\`\`\`bash
TWILIO_ACCOUNT_SID=AC... # required for default outbound SMS
TWILIO_AUTH_TOKEN=... # required for inbound signature verification
\`\`\``,
configure: `In the Twilio console, point your number's Messaging webhook at \`/eve/v1/twilio/messages\` and its Voice webhook at \`/eve/v1/twilio/voice\`. Inbound calls are answered with speech gathering, and the transcript feeds the same session SMS uses. See the [Twilio channel docs](/docs/channels/twilio) for dispatch, streaming, and voice specifics.`,
},
github: {
logo: "github",
docsHref: "/docs/channels/github",
keywords: ["issues", "pull requests", "app", "webhook", "code"],
install: `Add this channel from eve's registry to create a Vercel Connect GitHub App, route verified webhooks, and write \`agent/channels/github.ts\`:
\`\`\`bash
eve add channel/github
\`\`\``,
quickStart: `The guided setup writes \`agent/channels/github.ts\`:
\`\`\`ts
// agent/channels/github.ts
import { connectGitHubCredentials } from "@vercel/connect/eve";
import { githubChannel } from "eve/channels/github";
export default githubChannel({
credentials: connectGitHubCredentials("github/my-agent"),
});
\`\`\``,
configure: `Sign in to Vercel, then let the guided flow create or link a project, provision the GitHub App, and attach its verified webhook trigger to \`/eve/v1/github\`. Deploy, install the app from Vercel Connect, then add its \`@handle\` invocation token to a new issue, pull request, or review comment. GitHub may not autocomplete or render the token as a linked mention. See the [GitHub channel docs](/docs/channels/github) for permissions and events.`,
},
"linear-agent": {
logo: "linear",
docsHref: "/docs/channels/linear",
keywords: ["issues", "comments", "agent sessions", "developer preview", "webhook"],
install: `Add this channel from eve's registry to create a Vercel Connect client, route verified Agent Session events, and write \`agent/channels/linear.ts\`:
\`\`\`bash
eve add channel/linear-agent
\`\`\``,
quickStart: `The guided setup writes \`agent/channels/linear.ts\`:
\`\`\`ts
// agent/channels/linear.ts
import { connectLinearCredentials } from "@vercel/connect/eve";
import { linearChannel } from "eve/channels/linear";
export default linearChannel({
credentials: connectLinearCredentials("linear/my-agent"),
});
\`\`\``,
configure: `Sign in to Vercel, then let the guided flow create or link a project, provision the Linear app, and attach its verified AgentSessionEvent trigger to \`/eve/v1/linear\`. Deploy, install the app in your Linear workspace from Vercel Connect, then delegate an issue or mention the agent. See the [Linear channel docs](/docs/channels/linear) for Agent Activity behavior.`,
},
eve: {
logo: "eve",
docsHref: "/docs/channels/eve",
keywords: [
"web",
"chat",
"ui",
"embed",
"frontend",
"next.js",
"svelte",
"sveltekit",
"nuxt",
"vue",
"react",
],
install: `The eve CLI scaffolds the full Next.js web chat app alongside \`agent/channels/eve.ts\`:
\`\`\`bash
eve add channel/web
\`\`\`
To wire it up by hand instead — including into a Svelte or Nuxt app you already have — install the framework:
\`\`\`bash
npm install eve@latest
\`\`\``,
quickStart: `The eve channel is on by default. Add \`agent/channels/eve.ts\` only when you want to override the default session routes or auth:
\`\`\`ts
// agent/channels/eve.ts
import { eveChannel } from "eve/channels/eve";
export default eveChannel();
\`\`\`
Point your frontend at the session routes eve serves (\`/eve/v1/session\`) and stream responses with the eve web client. Next.js, Nuxt, and Svelte each have an integration that mounts those routes on your app's own origin, so there's no CORS to configure and no URL env var to keep in sync:
- **Next.js.** Wrap \`next.config.ts\` with \`withEve()\` from \`eve/next\`, then call \`useEveAgent()\` from \`eve/react\`. See the [Next.js guide](/docs/guides/frontend/nextjs).
- **Nuxt.** Add \`"eve/nuxt"\` to \`modules\` in \`nuxt.config.ts\`; the \`useEveAgent()\` composable from \`eve/vue\` is auto-imported. See the [Nuxt guide](/docs/guides/frontend/nuxt).
- **Svelte.** Add the \`eveSvelteKit()\` Vite plugin before \`sveltekit()\` in \`vite.config.ts\`, then call \`useEveAgent()\` from \`eve/svelte\`. See the [SvelteKit guide](/docs/guides/frontend/sveltekit).
On any other stack, wire it up by hand: run the agent as its own service and proxy \`/eve/v1/**\` to it, or pass its origin as \`host\` to \`useEveAgent()\` and enable \`cors\` on the channel. Server-side code and custom UIs can call the routes through \`Client\` from \`eve/client\`.`,
configure: `The eve channel is the lowest-friction way to talk to your agent, with no third-party provisioning required. Layer in auth and route protection as needed, and enable \`cors\` only when a browser reaches the channel from another origin. See the [eve channel docs](/docs/channels/eve), the [Frontend guide](/docs/guides/frontend/overview), and the per-framework guides for [Next.js](/docs/guides/frontend/nextjs), [Nuxt](/docs/guides/frontend/nuxt), and [SvelteKit](/docs/guides/frontend/sveltekit).`,
},
buzz: {
logo: "buzz",
docsHref: "https://github.com/vercel/eve/tree/main/packages/eve-buzz-acp-adapter#readme",
badge: "ACP",
keywords: ["chat", "messaging", "desktop", "acp", "nostr", "agents"],
install: `Install [Buzz Desktop](https://buzz.xyz), then install eve's compatibility adapter globally:
\`\`\`bash
npm install --global @eve/buzz-acp-adapter
\`\`\`
The adapter must be installed globally because Buzz uses it whenever it interfaces with eve.`,
quickStart: `From an eve application directory, run the interactive installer:
\`\`\`bash
eve-buzz-acp-adapter install
\`\`\`
You can also provide a local application or deployed URL explicitly:
\`\`\`bash
eve-buzz-acp-adapter install ./path/to/eve-app
eve-buzz-acp-adapter install https://agent.example.com
\`\`\`
The installer registers **eve** as a custom harness with Buzz.`,
configure: `Reopen Buzz, then create or edit an agent:
1. Enter an **Agent name** and, optionally, **Agent instructions** for Buzz-specific behavior.
2. Under **AI configuration**, choose **Customize for this agent**.
3. Set **Agent harness** to **eve**. Buzz currently requires a **Model** value but does not prefill one for custom harnesses.
4. Open **Advanced**. Leave **Who can talk to this agent** on its default owner-only selection. For a local application, set **Parallelism** to \`1\` and add any credentials that the application does not already load from an env file, such as \`AI_GATEWAY_API_KEY\`.
5. Save the agent and start it.
Accepted senders share one eve identity and its capabilities.`,
},
"chat-sdk-gchat": {
logo: "googlechat",
docsHref: "/docs/channels/chat-sdk",
badge: "Chat SDK",
keywords: ["chat sdk", "google chat", "spaces", "bot"],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/gchat.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-gchat
\`\`\``,
quickStart: `Create \`agent/channels/gchat.ts\`. Register Chat SDK handlers on \`bot\`, call \`send\` to hand each turn to eve, and export the channel:
\`\`\`ts
// agent/channels/gchat.ts
import { createGoogleChatAdapter } from "@chat-adapter/gchat";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: { gchat: createGoogleChatAdapter() },
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
Credentials come from the \`createGoogleChatAdapter\` config or the adapter's environment variables; see the [Google Chat adapter docs](https://chat-sdk.dev/adapters/official/gchat).`,
configure: `The adapter mounts its webhook at \`/eve/v1/gchat\`. Point your Google Chat app's HTTP endpoint at it. The adapter owns provider auth, verification, and delivery, while eve owns session dispatch, streaming, typing, and human-in-the-loop. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for routes, streaming, and state options.`,
},
"chat-sdk-whatsapp": {
logo: "whatsapp",
docsHref: "/docs/channels/chat-sdk",
badge: "Chat SDK",
keywords: ["chat sdk", "whatsapp", "business cloud", "messaging"],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/whatsapp.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-whatsapp
\`\`\``,
quickStart: `Create \`agent/channels/whatsapp.ts\`. Register Chat SDK handlers on \`bot\`, call \`send\` to hand each turn to eve, and export the channel:
\`\`\`ts
// agent/channels/whatsapp.ts
import { createWhatsAppAdapter } from "@chat-adapter/whatsapp";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: { whatsapp: createWhatsAppAdapter() },
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
Credentials come from the \`createWhatsAppAdapter\` config or the adapter's environment variables; see the [WhatsApp adapter docs](https://chat-sdk.dev/adapters/official/whatsapp).`,
configure: `The adapter mounts its webhook at \`/eve/v1/whatsapp\`. Point your WhatsApp Business Cloud webhook at it. The adapter owns provider auth, verification, and delivery, while eve owns session dispatch, streaming, typing, and human-in-the-loop. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for routes, streaming, and state options.`,
},
"chat-sdk-x": {
logo: "x",
docsHref: "/docs/channels/chat-sdk",
badge: "Chat SDK",
keywords: ["chat sdk", "x", "twitter", "mentions", "dms"],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/x.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-x
\`\`\``,
quickStart: `Create \`agent/channels/x.ts\`. Register Chat SDK handlers on \`bot\`, call \`send\` to hand each turn to eve, and export the channel:
\`\`\`ts
// agent/channels/x.ts
import { createXAdapter } from "@chat-adapter/x";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: { x: createXAdapter() },
state: createMemoryState(),
// X buffers replies and posts once rather than editing a streamed message.
streaming: false,
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onDirectMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
For a DM-only agent, keep \`bot.onDirectMessage\` and remove the \`bot.onNewMention\` and \`bot.onSubscribedMessage\` handlers. Configure the app's credentials and webhook before deploying.`,
configure: `Follow the [X adapter documentation](https://chat-sdk.dev/adapters/official/x) to configure authentication, webhook verification, and Activity API subscriptions. Register the deployed agent's \`/eve/v1/x\` route as the X webhook URL. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve route and state options.`,
},
"chat-sdk-messenger": {
logo: "messenger",
docsHref: "/docs/channels/chat-sdk",
badge: "Chat SDK",
keywords: ["chat sdk", "messenger", "facebook", "bot"],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/messenger.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-messenger
\`\`\``,
quickStart: `Create \`agent/channels/messenger.ts\`. Register Chat SDK handlers on \`bot\`, call \`send\` to hand each turn to eve, and export the channel:
\`\`\`ts
// agent/channels/messenger.ts
import { createMessengerAdapter } from "@chat-adapter/messenger";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: { messenger: createMessengerAdapter() },
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
Credentials come from the \`createMessengerAdapter\` config or the adapter's environment variables; see the [Messenger adapter docs](https://chat-sdk.dev/adapters/official/messenger).`,
configure: `The adapter mounts its webhook at \`/eve/v1/messenger\`. Point your Messenger webhook at it. The adapter owns provider auth, verification, and delivery, while eve owns session dispatch, streaming, typing, and human-in-the-loop. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for routes, streaming, and state options.`,
},
"chat-sdk-zernio": {
logo: "zernio",
docsHref: "/docs/channels/chat-sdk",
badge: "Provider official",
keywords: [
"chat sdk",
"zernio",
"instagram",
"facebook",
"x",
"twitter",
"telegram",
"whatsapp",
"bluesky",
"reddit",
],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/zernio.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-zernio
\`\`\``,
quickStart: `Create \`agent/channels/zernio.ts\`:
\`\`\`ts
// agent/channels/zernio.ts
import { createZernioAdapter } from "@zernio/chat-sdk-adapter";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: {
zernio: createZernioAdapter(),
},
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
See the [Zernio adapter documentation](https://chat-sdk.dev/adapters/vendor-official/zernio) for supported events, capabilities, and credentials.`,
configure: `Set \`ZERNIO_API_KEY\` and \`ZERNIO_WEBHOOK_SECRET\`, then point Zernio webhooks at \`/eve/v1/zernio\`. Zernio provides one adapter for Instagram, Facebook, X, Telegram, WhatsApp, Bluesky, and Reddit. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve session dispatch, state, streaming, and human-in-the-loop behavior.`,
},
"chat-sdk-velt": {
logo: "velt",
docsHref: "/docs/channels/chat-sdk",
badge: "Provider official",
keywords: [
"chat sdk",
"velt",
"comments",
"collaboration",
"documents",
"canvas",
"pdf",
"video",
],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/velt.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-velt
\`\`\``,
quickStart: `Create \`agent/channels/velt.ts\`:
\`\`\`ts
// agent/channels/velt.ts
import { createVeltAdapter } from "@veltdev/chat-sdk-adapter";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: {
velt: createVeltAdapter({
apiKey: process.env.VELT_API_KEY!,
webhookSecret: process.env.VELT_WEBHOOK_SECRET!,
botUserId: "my-agent",
botUserName: "My Agent",
}),
},
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
See the [Velt adapter documentation](https://chat-sdk.dev/adapters/vendor-official/velt) for supported events, capabilities, and credentials.`,
configure: `Create a Velt bot user and webhook, set \`VELT_API_KEY\` and \`VELT_WEBHOOK_SECRET\`, then send comment events to \`/eve/v1/velt\`. The adapter maps documents to channels, annotations to threads, and comments to messages. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve session dispatch, state, streaming, and human-in-the-loop behavior.`,
},
"chat-sdk-sendblue": {
logo: "sendblue",
docsHref: "/docs/channels/chat-sdk",
badge: "Provider official",
keywords: ["chat sdk", "sendblue", "imessage", "sms", "rcs", "tapbacks", "phone"],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/sendblue.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-sendblue
\`\`\``,
quickStart: `Create \`agent/channels/sendblue.ts\`:
\`\`\`ts
// agent/channels/sendblue.ts
import { createSendblueAdapter } from "chat-adapter-sendblue";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: {
sendblue: createSendblueAdapter(),
},
state: createMemoryState(),
streaming: false,
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
See the [Sendblue adapter documentation](https://chat-sdk.dev/adapters/vendor-official/sendblue) for supported events, capabilities, and credentials.`,
configure: `Set \`SENDBLUE_API_KEY\`, \`SENDBLUE_API_SECRET\`, and \`SENDBLUE_FROM_NUMBER\`, then point Sendblue webhooks at \`/eve/v1/sendblue\`. The adapter also supports tapbacks, typing indicators, delivery callbacks, and number lookup. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve session dispatch, state, streaming, and human-in-the-loop behavior.`,
},
"chat-sdk-novu": {
logo: "novu",
docsHref: "/docs/channels/chat-sdk",
badge: "Provider official",
keywords: [
"chat sdk",
"novu",
"slack",
"teams",
"whatsapp",
"telegram",
"email",
"multichannel",
],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/novu.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-novu
\`\`\``,
quickStart: `Create \`agent/channels/novu.ts\`:
\`\`\`ts
// agent/channels/novu.ts
import { createNovuAdapter } from "@novu/chat-sdk-adapter";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: {
novu: createNovuAdapter(),
},
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
See the [Novu adapter documentation](https://chat-sdk.dev/adapters/vendor-official/novu) for supported events, capabilities, and credentials.`,
configure: `Run \`npx novu connect --runtime chat-sdk\` to authenticate Novu, choose a channel, and create the required environment variables. Novu manages provider credentials, identity, delivery, and conversation history across its supported channels. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve session dispatch, state, streaming, and human-in-the-loop behavior.`,
},
"chat-sdk-liveblocks": {
logo: "liveblocks",
docsHref: "/docs/channels/chat-sdk",
badge: "Provider official",
keywords: [
"chat sdk",
"liveblocks",
"comments",
"collaboration",
"threads",
"mentions",
"reactions",
],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/liveblocks.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-liveblocks
\`\`\``,
quickStart: `Create \`agent/channels/liveblocks.ts\`:
\`\`\`ts
// agent/channels/liveblocks.ts
import { createLiveblocksAdapter } from "@liveblocks/chat-sdk-adapter";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: {
liveblocks: createLiveblocksAdapter({
apiKey: process.env.LIVEBLOCKS_SECRET_KEY!,
webhookSecret: process.env.LIVEBLOCKS_WEBHOOK_SECRET!,
botUserId: "my-agent",
botUserName: "My Agent",
}),
},
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
See the [Liveblocks adapter documentation](https://chat-sdk.dev/adapters/vendor-official/liveblocks) for supported events, capabilities, and credentials.`,
configure: `Create a Liveblocks webhook, set \`LIVEBLOCKS_SECRET_KEY\` and \`LIVEBLOCKS_WEBHOOK_SECRET\`, and send comment events to \`/eve/v1/liveblocks\`. The adapter maps rooms to channels, comment threads to threads, and comments to messages. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve session dispatch, state, streaming, and human-in-the-loop behavior.`,
},
linq: {
logo: "linq",
docsHref: "/docs/channels/linq",
badge: "First-party",
keywords: ["linq", "imessage", "sms", "apple messages", "tapbacks", "phone"],
install: `Add Linq from eve's registry, then follow the guided Connect or portable credential setup:
\`\`\`bash
eve add channel/linq
\`\`\``,
quickStart: `Create \`agent/channels/linq.ts\`:
\`\`\`ts
import { connectLinqCredentials } from "@vercel/connect/eve";
import { linqChannel } from "eve/channels/linq";
export default linqChannel({
credentials: connectLinqCredentials("linq/my-agent"),
});
\`\`\``,
configure: `The guided setup can provision a managed Linq line with Vercel Connect or collect portable credentials. Connect-backed setup creates a native Linq connector and routes verified triggers to \`/eve/v1/linq\`; with portable credentials, deploy first, then create a signed Linq webhook for that route.`,
},
"chat-sdk-kapso": {
logo: "kapso",
docsHref: "/docs/channels/chat-sdk",
badge: "Provider official",
keywords: ["chat sdk", "kapso", "whatsapp", "meta", "business", "buttons", "media"],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/kapso.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-kapso
\`\`\``,
quickStart: `Create \`agent/channels/kapso.ts\`:
\`\`\`ts
// agent/channels/kapso.ts
import { createKapsoAdapter } from "@kapso/chat-adapter";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: {
kapso: createKapsoAdapter({
kapsoApiKey: process.env.KAPSO_API_KEY!,
phoneNumberId: process.env.KAPSO_PHONE_NUMBER_ID!,
webhookSecret: process.env.KAPSO_WEBHOOK_SECRET!,
}),
},
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
See the [Kapso adapter documentation](https://chat-sdk.dev/adapters/vendor-official/kapso) for supported events, capabilities, and credentials.`,
configure: `Connect a WhatsApp number in Kapso, set \`KAPSO_API_KEY\`, \`KAPSO_PHONE_NUMBER_ID\`, and \`KAPSO_WEBHOOK_SECRET\`, then point the Kapso webhook at \`/eve/v1/kapso\`. Use this provider-managed option when you do not want to integrate directly with the WhatsApp Cloud API. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve session dispatch, state, streaming, and human-in-the-loop behavior.`,
},
photon: {
logo: "photon",
docsHref: "/docs/channels/photon",
badge: "First-party",
keywords: ["imessage", "apple messages", "photon", "sms", "phone"],
install: `Add Photon from eve's registry, then follow the guided project, phone, and deployment setup:
\`\`\`bash
eve add channel/photon-imessage
\`\`\``,
quickStart: `Create \`agent/channels/photon.ts\`:
\`\`\`ts
import { connectPhotonCredentials } from "@vercel/connect/eve";
import { photonIMessageChannel } from "eve/channels/photon";
export default photonIMessageChannel({
credentials: connectPhotonCredentials("photon/my-agent"),
});
\`\`\``,
configure: `The guided setup can create a dedicated Photon project or use existing credentials, register your phone, and choose Vercel Connect or portable environment credentials. Connect-backed setup creates a native Photon connector and routes verified triggers to \`/eve/v1/photon\`; portable setup registers a signed Photon webhook directly.`,
},
"chat-sdk-dial": {
logo: "dial",
docsHref: "/docs/channels/chat-sdk",
badge: "Provider official",
keywords: ["chat sdk", "dial", "sms", "mms", "imessage", "voice", "phone", "calls"],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/dial.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-dial
\`\`\``,
quickStart: `Create \`agent/channels/dial.ts\`:
\`\`\`ts
// agent/channels/dial.ts
import { createDialAdapter } from "@getdial/chat-sdk-adapter";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: {
dial: createDialAdapter({
apiKey: process.env.DIAL_API_KEY!,
fromNumberId: process.env.DIAL_FROM_NUMBER_ID!,
webhookSecret: process.env.DIAL_WEBHOOK_SECRET!,
}),
},
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
See the [Dial adapter documentation](https://chat-sdk.dev/adapters/vendor-official/dial) for supported events, capabilities, and credentials.`,
configure: `Create a Dial number, set \`DIAL_API_KEY\`, \`DIAL_FROM_NUMBER_ID\`, and \`DIAL_WEBHOOK_SECRET\`, then point its webhook at \`/eve/v1/dial\`. Dial maps each phone-number pair to a thread and delivers SMS, MMS, iMessage, and voice transcripts. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve session dispatch, state, streaming, and human-in-the-loop behavior.`,
},
"chat-sdk-agentphone": {
logo: "agentphone",
docsHref: "/docs/channels/chat-sdk",
badge: "Provider official",
keywords: ["chat sdk", "agentphone", "sms", "mms", "imessage", "voice", "phone", "calls"],
install: `Add this Chat SDK channel from eve's registry. This writes \`agent/channels/agentphone.ts\` and installs Chat SDK and its adapter dependencies:
\`\`\`bash
eve add channel/chat-sdk-agentphone
\`\`\``,
quickStart: `Create \`agent/channels/agentphone.ts\`:
\`\`\`ts
// agent/channels/agentphone.ts
import { createAgentPhoneAdapter } from "@agentphone/chat-sdk-adapter";
import { createMemoryState } from "@chat-adapter/state-memory";
import type { Message, Thread } from "chat";
import { chatSdkChannel } from "eve/channels/chat-sdk";
export const { bot, channel, send } = chatSdkChannel({
userName: "My Agent",
adapters: {
agentphone: createAgentPhoneAdapter({
apiKey: process.env.AGENTPHONE_API_KEY!,
agentId: process.env.AGENTPHONE_AGENT_ID!,
webhookSecret: process.env.AGENTPHONE_WEBHOOK_SECRET!,
}),
},
state: createMemoryState(),
});
bot.onNewMention(async (thread: Thread, message: Message) => {
await thread.subscribe();
await send(message.text, { thread });
});
bot.onSubscribedMessage(async (thread: Thread, message: Message) => {
await send(message.text, { thread });
});
export default channel;
\`\`\`
See the [AgentPhone adapter documentation](https://chat-sdk.dev/adapters/vendor-official/agentphone) for supported events, capabilities, and credentials.`,
configure: `Create an AgentPhone agent, set \`AGENTPHONE_API_KEY\`, \`AGENTPHONE_AGENT_ID\`, and \`AGENTPHONE_WEBHOOK_SECRET\`, then point its webhook at \`/eve/v1/agentphone\`. The adapter handles SMS, MMS, iMessage, and completed voice-call transcripts. See the [Chat SDK channel docs](/docs/channels/chat-sdk) for eve session dispatch, state, streaming, and human-in-the-loop behavior.`,