Class: MCPEvents

Defined in: packages/mcp/src/events.ts:54

Constructors

Constructor

new MCPEvents(backend): MCPEvents

Defined in: packages/mcp/src/events.ts:56

Parameters

backend

MCPProtocolClient

Returns

MCPEvents

Methods

batches()

batches(selection, options?): AsyncGenerator<{[key: string]: unknown; cursor?: string | null; events: object[]; hasMore?: boolean; nextPollMs: number; truncated?: boolean; }>

Defined in: packages/mcp/src/events.ts:91

Empty batches expose quiet cursor advances. Backlog drains without the poll delay.

Parameters

selection

MCPEventSelection

options?

minimumPollMs?

number

signal?

AbortSignal

Returns

AsyncGenerator<{[key: string]: unknown; cursor?: string | null; events: object[]; hasMore?: boolean; nextPollMs: number; truncated?: boolean; }>

---

list()

list(cursor?, signal?): Promise<{[key: string]: unknown; events: object[]; nextCursor?: string; }>

Defined in: packages/mcp/src/events.ts:58

Parameters

cursor?

string

signal?

AbortSignal

Returns

Promise<{[key: string]: unknown; events: object[]; nextCursor?: string; }>

---

listChanges()

listChanges(signal?): AsyncGenerator<void>

Defined in: packages/mcp/src/events.ts:64

Coalesce legacy registry invalidations. Re-list periodically on modern connections.

Parameters

signal?

AbortSignal

Returns

AsyncGenerator<void>

---

poll()

poll(selection, signal?): Promise<{[key: string]: unknown; cursor?: string | null; events: object[]; hasMore?: boolean; nextPollMs: number; truncated?: boolean; }>

Defined in: packages/mcp/src/events.ts:86

Parameters

selection

MCPEventSelection

signal?

AbortSignal

Returns

Promise<{[key: string]: unknown; cursor?: string | null; events: object[]; hasMore?: boolean; nextPollMs: number; truncated?: boolean; }>

---

stream()

stream(selection, options?): AsyncGenerator<MCPEventUpdate>

Defined in: packages/mcp/src/events.ts:123

Caller-managed reconnection: resume with the cursor from the last consumed update.

Parameters

selection

Omit<MCPEventSelection, "maxEvents">

options?

MCPEventStreamOptions = {}

Returns

AsyncGenerator<MCPEventUpdate>

---

subscribe()

subscribe(webhook, signal?): Promise<{[key: string]: unknown; cursor?: string | null; deliveryStatus?: Record<string, unknown>; id: string; refreshBefore: string | null; truncated?: boolean; }>

Defined in: packages/mcp/src/events.ts:105

Parameters

webhook

MCPEventWebhook

signal?

AbortSignal

Returns

Promise<{[key: string]: unknown; cursor?: string | null; deliveryStatus?: Record<string, unknown>; id: string; refreshBefore: string | null; truncated?: boolean; }>

---

unsubscribe()

unsubscribe(name, args, url, signal?): Promise<void>

Defined in: packages/mcp/src/events.ts:118

Parameters

name

string

args

Record<string, unknown> | undefined

url

string

signal?

AbortSignal

Returns

Promise<void>

---

createWebhookSecret()

static createWebhookSecret(): string

Defined in: packages/mcp/src/events.ts:55

Returns

string