AI Agents (MCP)
StepsKit ships an MCP server,
@stepskit/mcp, so your AI coding
agent can install StepsKit and author in-app guidance — product tours, contextual
tooltips, NPS surveys, and announcement banners — from inside your codebase.
Because the agent already has your components and selectors on disk, the
experiences it drafts point at the right elements from the start.
It works with any MCP client — Claude Code, Cursor, Codex, Claude Desktop, and others. The server is the same everywhere; only the way you register it differs (see Connect your agent).
The flow
- Status — the agent calls
get_integration_statusto see whether the embed is installed, which domains are allowed, and how many tours exist. A token that covers your whole account resolves which project it's writing to first — automatic when you own one, alist_projectscall away when you own several (see Pick a project). - Install — if the embed isn't installed, the agent detects your framework and adds the snippet to the right file. You review the diff.
- Identify — the agent finds where your app resolves the logged-in user and
wires
identify()there, passing the attributes your user object already carries. Without this, "show once" and audience targeting can't work — see the install prompt for what a proper install looks like. - Verify — after you load a page once,
verify_integrationconfirms the embed actually pinged StepsKit, so you know tours can render. - Domain —
add_allowed_domainwhitelists your production domain (localhost is always allowed). - Create —
create_tourpersists a tour from codebase context, as an unpublished draft. - Review & publish — you review the tour in the StepsKit dashboard and publish it deliberately. The agent never publishes on its own.
The tools your agent gets
Grouped by what they touch — the full per-tool reference lives on the MCP server reference page:
| Group | What it covers |
|---|---|
| Projects | List the projects the token can reach and choose which one to write to. Only comes into play with an account-wide token; a project-scoped one is pinned by the credential. |
| Setup & integration | Onboarding state and install snippet, embed verification, domain whitelisting, URL-pattern suggestions, and get_capabilities (the live can/can't list). |
| Tours | Create unpublished tours; list and read them; edit name, behavior settings, visibility/targeting, and per-tour theme. |
| Steps | Add, edit, delete, and reorder steps. Editing keeps step ids (and analytics). |
| Tooltips | Create and edit contextual indicators — a ?/info glyph, dot/pulse, or NEW/BETA badge anchored to one element, opening a popover with an optional CTA. |
| NPS surveys | Create and edit bottom-corner NPS cards — question, rating scale, follow-up, thank-you, re-survey window. |
| Announcements | Create and edit top/bottom banner strips, with an optional schedule window. |
| Project themes | Read and set the four project-wide defaults — one each for tours, tooltips, announcement banners, and survey cards — that every item inherits. |
Next steps
- Connect your agent — per-client setup for Claude Code, Cursor, Codex, and others.
- Install prompt — a copy-pasteable prompt that installs StepsKit properly in any agent, no MCP server required.
- Capabilities & limits — what you can and can't ask it to do.
- MCP server reference — the
@stepskit/mcppackage: configuration, environment variables, every tool, guardrails, and token security. - Troubleshooting — when the server or a tour doesn't show up.