ActivitySmith Quickstart Guide

1. Add the ActivitySmith MCP server to your client

claude mcp add --transport http --scope user activitysmith https://mcp.activitysmith.com/mcp

2. Approve access in your browser

Run /mcp in a Claude Code session, then select ActivitySmith to open the sign-in screen. Review the access the client requests, then approve it. ActivitySmith tools run against the account you approve.

To let your agent set up code that calls the API on its own, tick Manage API keys on the approval screen. Learn more about MCP permissions

3. Try it with your agent

Start a new agent session with ActivitySmith enabled. Copy one of these prompts and use it alongside your task.

Use ActivitySmith to show me the progress of this task on my iPhone.

Push Notification

1
import ActivitySmith from "activitysmith";
2
3
const activitysmith = new ActivitySmith({
4
  apiKey: process.env.ACTIVITYSMITH_API_KEY!,
5
});
6
7
await activitysmith.notifications.send({
8
  title: "Cha-ching! 💸",
9
  message: "Trial user upgraded to Pro plan",
10
});

Live Activity

1
import ActivitySmith from "activitysmith";
2
3
const activitysmith = new ActivitySmith({
4
  apiKey: process.env.ACTIVITYSMITH_API_KEY!,
5
});
6
7
await activitysmith.liveActivities.stream("sales-hourly", {
8
  content_state: {
9
    title: "Sales",
10
    subtitle: "last hour",
11
    type: "stats",
12
    metrics: [
13
      { label: "Revenue", value: "$2430", color: "blue" },
14
      { label: "Orders", value: "37", color: "green" },
15
      { label: "Conversion", value: "4.8%", color: "magenta" },
16
      { label: "Avg Order", value: "$65.68", color: "yellow" },
17
    ],
18
  },
19
});

Do I need an API key to use ActivitySmith with my AI agent?

No. The MCP connection uses OAuth. Your agent signs in to your ActivitySmith account, so you never paste an API key into a prompt. Create an API key only when your own code calls the ActivitySmith API.

My agent does not show the ActivitySmith tools.

Start a new agent session after you approve access. If the tools are still missing, sign in again from your client. In Claude Code, run /mcp. In Codex, run codex mcp login activitysmith.

Where do I create an API key?

Open the API Keys page in the web app and create a new key.

Why is my device not receiving anything?

ActivitySmith delivers events to paired iOS devices. Install or open the iOS app and log in with the same account. Pairing happens automatically during onboarding.

Do I still need to open Devices to pair?

No. Onboarding pairs your device during setup. To confirm that your device is connected, open the Devices tab in the iOS app and send a test notification. If it still does not arrive, unpair the device, then tap Pair this device.

Should I connect an AI agent or use the API?

Connect an AI agent if you want updates about the work your agent does for you. Use the API if your backend, scripts, or CI should send events without an agent. You can set up both.