Skip to content
Engram Docs

ConsumeParams

Defined in: packages/auth/src/ratelimit/rate-limit.service.ts:20

Properties

Section titled “Properties”

key

Section titled “key”

key: string

Defined in: packages/auth/src/ratelimit/rate-limit.service.ts:22

Stable identity for the caller: api-key id, user id, or client IP.

tool?

Section titled “tool?”

optional tool?: string

Defined in: packages/auth/src/ratelimit/rate-limit.service.ts:24

MCP tool being invoked, when known (enables per-tool overrides).

units?

Section titled “units?”

optional units?: number

Defined in: packages/auth/src/ratelimit/rate-limit.service.ts:32

Work units this request represents (default 1). Tool calls that fan out into many downstream operations (e.g. ingest_conversation storing N chunks, each an embedding + vector search + DB write) charge one unit per operation, so a single metered request cannot amplify into unmetered work. Non-finite or sub-1 values are normalized to 1.