Knock

Get an object wihin a collection. Returns information about the object including any custom properties. Use this tool when you need to retrieve an object to understand it's properties.

get_object

Retrieves a tenant by their ID. Tenants in Knock are used to model organizations, teams, and other groups of users. They are a special type of object. Use this tool when you need to lookup the information about a tenant, including name, and if there are any custom properties set.

get_tenant

Retrieves the complete user object for the given userId, including email, name, phone number, and any custom properties. Use this tool when you need to retrieve a user's complete profile. If the userId is not provided, it will use the userId from the config.

get_user

Retrieves the messages that this user has received from the service. Use this tool when you need information about the notifications that the user has received, including if the message has been read, seen, or interacted with. This will return a list of messages across all of the channels. If the userId is not provided, it will use the userId from the config.

get_user_messages

Retrieves the user's notification preferences for the given userId. If the userId is not provided, it will use the userId from the config.

get_user_preferences

Lists all environments available, returning the slug and name of each environment. Use this tool when you need to see what environments are available.

list_environments

List all objects in a single collection. Objects are used to model custom collections in Knock that are NOT users or tenants. Use this tool when you need to return a paginated list of objects in a single collection.

list_objects

Retrieves a list of tenants. Tenants in Knock are used to model organizations, teams, and other groups of users. They are a special type of object. Use this tool when you need to list all tenants in an environment.

list_tenants

This is the Management API: workflows, channels, templates, commits, and configuration. This session allows **read and write**. Use `execute_mapi_read` for `GET` and `execute_mapi_write` for `POST`/`PUT`/`PATCH`/`DELETE`. Use `search_mapi` to explore or filter the OpenAPI spec for the **mapi** API before calling `execute_mapi_read` or `execute_mapi_write`. All $ref pointers are pre-resolved inline. Types: // OpenAPI 3.x spec with $refs resolved inline. interface OperationObject { summary?: string; description?: string; operationId?: string; tags?: string[]; parameters?: Array<{ name: string; in: "query" | "header" | "path" | "cookie"; required?: boolean; schema?: unknown; description?: string; }>; requestBody?: { required?: boolean; content?: Record<string, { schema?: unknown }> }; responses?: Record<string, { content?: Record<string, { schema?: unknown }> }>; } interface PathItem { get?: OperationObject; post?: OperationObject; put?: OperationObject; patch?: OperationObject; delete?: OperationObject; } interface OpenApiSpec { openapi: string; info: { title: string; version: string; description?: string }; paths: Record<string, PathItem>; servers?: Array<{ url: string }>; components?: Record<string, unknown>; tags?: Array<{ name: string; description?: string }>; } declare const mapi: { spec(): Promise<OpenApiSpec> }; Your code must be a single JavaScript async arrow function (no TypeScript) that returns a small, filtered result. Example: async () => { const spec = await mapi.spec(); return Object.keys(spec.paths).slice(0, 20); }

search_mapi

Search the Knock documentation for a given query

search_documentation

Overwrites the user's notification preferences for the given userId. Allows setting per-workflow, per-category, or per-channel notification preferences. Use this tool when you are asked to update a user's notification preferences. If the userId is not provided, it will use the userId from the config. Instructions: - You must ALWAYS provide a full preference set to this tool. - When setting per-workflow preferences, the key in the object should be the workflow key. - Workflow and category preferences should always have channel types underneath. - The channel types available to you are: email, sms, push, chat, and in_app_feed. - To turn OFF a preference, you must set it to false. - To turn ON a preference, you must set it to true. <examples> <example> <description> Update the user's preferences to turn off email notifications for the "welcome" workflow. </description> <input> { "workflows": { "welcome": { "channel_types": { "email": false } } } } </example> </examples>

set_user_preferences

Use Knock's hosted agent to create and update workflows, broadcasts, guides, email layouts, partials, and translations. Prefer this tool when creating or updating those resources in a Knock account — the hosted agent has full account context and usually needs fewer tokens than calling the Management API directly. Use Management API code mode (`search_mapi` / `execute_mapi_read` / `execute_mapi_write`) when you need a specific API call, or when the user asks to use the API. For analytics questions, the Knock agent can return high-level message and engagement data. Those queries are not available through the Management API. Pass the user's request verbatim in prompt. Do not reinterpret or shorten it. This tool waits up to ~45 seconds, then returns a consolidated result. Read the Status line in the response: - Status: complete — the run finished; use the agent response and modified resources. - Status: error — the run failed; read the Error line. - Status: running — the run is still going; save the Session ID and poll with get_knock_agent until Status is complete or error. Agents can support follow-up runs by passing in the returned session_id. Use a follow-up run only for related edits or questions about a resource you just modified. Otherwise, use the Management API or start a new agent session.

start_knock_agent

Subscribe a list of users to an object in a specific collection. We use this to model lists of users, for pub-sub use cases. Use this tool when you need to subscribe one or more users to an object where you will then trigger workflows for those lists of users to send notifications to. Before using this tool, you should create the object in the collection using the createOrUpdateObject tool.

subscribe_users_to_object

Unsubscribe a list of users from an object in a specific collection. We use this to model lists of users, for pub-sub use cases. Use this tool when you need to unsubscribe one or more users from an object where you will then trigger workflows for those lists of users to send notifications to.

unsubscribe_users_from_object