Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Zulip

Scalekit connector
Open markdown

The Zulip connector lets your AI agent act in each user's Zulip account. Each user connects their own Zulip API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.

Tools
59
What they doRead · write · destructive
27 · 23 · 927 read23 write9 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Zulip connection

    In AgentKit > Connections, create a Zulip connection. The name you give it is the connection_name your code passes. See Configure connections.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • zulip_channel_getGet one channel by ID.Read-only

    Get Channel

    Get one channel by ID. Returns stream with name, description, privacy settings and permissions. Use zulip_channel_get when you have the ID.

    Inputs

    stream_idintegerrequired
    ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.
  • zulip_channel_id_getLook up a channel's ID by name.Read-only

    Get Channel ID

    Look up a channel's ID by name. Returns stream_id. Use zulip_channel_id_get before tools that take a stream_id.

    Inputs

    streamstringrequired
    Channel name. Example: general.
  • zulip_channel_subscribers_listList the users subscribed to a channel.Read-only

    List Channel Subscribers

    List the users subscribed to a channel. Returns subscribers[], user IDs. Use zulip_channel_subscribers_list to see who is in a channel.

    Inputs

    stream_idintegerrequired
    ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.
  • zulip_channel_topics_listList a channel's topics, most recent first.Read-only

    List Channel Topics

    List a channel's topics, most recent first. Returns topics[] with name and max_id. Use zulip_channel_topics_list before reading a topic with zulip_messages_get.

    Inputs

    stream_idintegerrequired
    ID of the channel (get it from zulip_channels_list or zulip_channel_id_get). Example: 15.
  • zulip_channels_listList channels (streams) you can see, optionally including all public, web-public or archived ones.Read-only

    List Channels

    List channels (streams) you can see, optionally including all public, web-public or archived ones. Returns streams[] with stream_id, name, description, invite_only and is_archived. Use zulip_channels_list to find a channel ID. Use zulip_subscriptions_list for channels you are in.

    Inputs

    exclude_archivedboolean
    Leave out archived channels. Defaults to true. Example: true.
    include_publicboolean
    Include all public channels. Defaults to true. Example: true.
    include_subscribedboolean
    Include channels you are subscribed to. Defaults to true. Example: true.
    include_web_publicboolean
    Include web-public channels. Defaults to false. Example: false.
  • zulip_custom_emoji_listList the organization's custom emoji.Read-only

    List Custom Emoji

    List the organization's custom emoji. Returns emoji keyed by ID with name, source_url and deactivated. Use zulip_custom_emoji_list to find custom emoji names for reactions.

    Inputs

    This tool takes no inputs.

  • zulip_drafts_listList your message drafts.Read-only

    List Drafts

    List your message drafts. Returns drafts[] with id, type, to, topic, content and timestamp. Use zulip_drafts_list to find saved drafts.

    Inputs

    This tool takes no inputs.

  • zulip_invites_listList pending email invitations and reusable invite links.Read-only

    List Invitations

    List pending email invitations and reusable invite links. Returns invites[] with id, email, invited_as and expiry. Use zulip_invites_list to review open invitations.

    Inputs

    This tool takes no inputs.