Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to the Bird MCP server

Vendor MCP
Open markdown

The Bird MCP connector routes your AI agent's tool calls to Bird's own MCP server through Scalekit. Each user signs in to Bird once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 673 tools.

Tools
673
What they doRead · write · destructive
396 · 182 · 95396 read182 write95 destructive
Users sign in with
OAuth app
Your own Bird MCP server app

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 Bird MCP connection

    In AgentKit > Connections, create a Bird MCP connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

  4. Register an OAuth app

    Bird MCP server connections use your own OAuth app. Register one with Bird MCP server and add the redirect URI you copied.

    Then enter the app's Client ID and Client Secret on the Bird MCP connection.

  5. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'birdmcp'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Bird MCP:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'birdmcp_whoami',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • birdmcp_amb_attachmentDownloads and decrypts one attachment from a message by its position, returning the file bytes.Read-only

    Get a message attachment

    Downloads and decrypts one attachment from a message by its position, returning the file bytes. Use it to read a photo or file a customer sent; the message ID is the `message.id` of the `amb.received` webhook. Apple keeps an attachment for about 30 days, so download on receipt.

    Inputs

    indexintegerrequired
    Zero-based position in the message's text.attachments array.
    message_idstringrequired
    Message ID (amb_). For a received attachment, the message.id of the amb.received webhook event.
  • birdmcp_amb_attachments_downloadDownloads and decrypts an attachment by its `aat_` ID, returning the file bytes.Read-only

    Download an attachment

    Downloads and decrypts an attachment by its `aat_` ID, returning the file bytes. Works for attachments a customer sent, attachments you sent and files you uploaded. A received attachment stays downloadable after `expires_at` when Bird kept a copy; otherwise Apple may no longer hold it.

    Inputs

    attachment_idstringrequired
    Attachment ID (aat_), from text.attachments[].attachment_id on a message or webhook, or from an upload.
  • birdmcp_amb_attachments_getReturns an attachment's metadata by its `aat_` ID: the business account that holds it, its origin, the message it belongs to, its name, media type, size and `expires_at`.Read-only

    Get an attachment

    Returns an attachment's metadata by its `aat_` ID: the business account that holds it, its origin, the message it belongs to, its name, media type, size and `expires_at`. Use it to check that an attachment ID is still sendable before reusing it; download the bytes with the content operation.

    Inputs

    attachment_idstringrequired
    Attachment identifier. Starts with aat_.
  • birdmcp_amb_business_accounts_events_listReturns account activity with event time, summary and source metadata, newest first by default.Read-only

    List Apple business account events

    Returns account activity with event time, summary and source metadata, newest first by default.

    Inputs

    business_account_idstringrequired
    ID of the Apple Messages for Business record, as returned by the business list.
    ending_beforestring
    Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
    include_totalboolean
    When true, the response includes a total field with the total number of items matching the request's filters across all pages.
    limitinteger
    Maximum number of items to return per page.
    orderstring
    Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.
    sortstring
    Field to sort by. Possible values: created_at. Defaults to created_at.
    starting_afterstring
    Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
  • birdmcp_amb_business_accounts_getReads a business record in your workspace.Read-only

    Get an Apple Messages for Business record

    Reads a business record in your workspace. Its apple_business_id supplies the from field for sends; creating a draft does not establish Apple approval.

    Inputs

    business_account_idstringrequired
    Bird business account ID (abz_) or Apple business UUID. Both resolve within the current workspace.
  • birdmcp_amb_business_accounts_listLists the Apple businesses registered in your workspace, with cursor pagination.Read-only

    List Apple Messages for Business records

    Lists the Apple businesses registered in your workspace, with cursor pagination. Requires business-management read permission. Use the configured apple_business_id when sending; onboarding status does not gate messaging.

    Inputs

    ending_beforestring
    Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
    include_totalboolean
    When true, the response includes a total field with the total number of items matching the request's filters across all pages.
    limitinteger
    Maximum number of items to return per page.
    orderstring
    Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.
    sortstring
    Field to sort by. Possible values: created_at. Defaults to created_at.
    starting_afterstring
    Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
  • birdmcp_amb_business_accounts_settings_getReturns the channel settings for your workspace's Apple Messages for Business record: its entry points, default locale, and the brand name and logo shown on the landing page customers use to connect it.Read-only

    Get Apple Messages for Business channel settings

    Returns the channel settings for your workspace's Apple Messages for Business record: its entry points, default locale, and the brand name and logo shown on the landing page customers use to connect it.

    Inputs

    business_account_idstringrequired
    ID of the Apple Messages for Business record, as returned by the business list.
  • birdmcp_amb_business_accounts_submissions_listLists the review attempts for a business in your workspace.Read-only

    List Apple Messages for Business submissions

    Lists the review attempts for a business in your workspace. Each attempt retains the business identity and evidence selected at submission.

    Inputs

    business_account_idstringrequired
    ID of the Apple Messages for Business record, as returned by the business list.
    ending_beforestring
    Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
    include_totalboolean
    When true, the response includes a total field with the total number of items matching the request's filters across all pages.
    limitinteger
    Maximum number of items to return per page.
    orderstring
    Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.
    sortstring
    Field to sort by. Possible values: created_at. Defaults to created_at.
    starting_afterstring
    Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.