Docs
Ask your AI assistant
Pairfully runs an MCP server, so Claude, Cursor and other assistants can read your reports, exit reasons, hot visitors and leads, and answer in plain English. Included on the Scale and Agency plans.
What you can ask
Once connected, ask in your own words. For example:
- “Why did conversions drop this week?”
- “What’s the top fix from this week’s report?”
- “Which pages cause the most friction?”
- “Any hot visitors in the last hour?”
- “Explain session cmx8k2… in plain English.”
- “Email me when a likely buyer is about to leave.”
The assistant picks the right tool, and answers from the same numbers as your dashboard and weekly report. There is also a weekly_briefing prompt that walks through the latest report, the biggest movers and the first fix to make.
Get a key
In the dashboard, open Settings → API and create a key. Owners and admins can create keys on the Scale and Agency plans. The key starts with pf_sk_ and is shown once, so paste it straight into the config below. Keep it out of shared repositories: anyone with it can read your organisation’s data.
The server speaks Streamable HTTP at https://api.pairfully.com/mcp and takes the key as Authorization: Bearer pf_sk_….
Claude Code
Add the server from your terminal:
claude mcp add --transport http pairfully https://api.pairfully.com/mcp --header "Authorization: Bearer pf_sk_…"Or share it with your team through a .mcp.json in the project root. Each person sets PAIRFULLY_API_KEY in their own environment, so the key never lands in the repository.
{
"mcpServers": {
"pairfully": {
"type": "http",
"url": "https://api.pairfully.com/mcp",
"headers": {
"Authorization": "Bearer ${PAIRFULLY_API_KEY}"
}
}
}
}Claude Desktop
Claude Desktop’s custom connectors expect OAuth sign-in, which Pairfully doesn’t offer yet. Until it does, connect through mcp-remote, which forwards your key. Open claude_desktop_config.json (Settings → Developer → Edit Config) and add:
{
"mcpServers": {
"pairfully": {
"command": "npx",
"args": [
"mcp-remote",
"https://api.pairfully.com/mcp",
"--header",
"Authorization:${PAIRFULLY_AUTH}"
],
"env": {
"PAIRFULLY_AUTH": "Bearer pf_sk_…"
}
}
}
}The key sits in env rather than in args because some versions split arguments that contain a space. Quit and reopen Claude Desktop, then look for Pairfully in the tools menu. It needs Node.js installed.
Cursor
Add this to ~/.cursor/mcp.json for every project, or .cursor/mcp.json for one:
{
"mcpServers": {
"pairfully": {
"url": "https://api.pairfully.com/mcp",
"headers": {
"Authorization": "Bearer pf_sk_…"
}
}
}
}Other clients
Any client that supports Streamable HTTP can connect. The server is stateless: point it at https://api.pairfully.com/mcp and send Authorization: Bearer pf_sk_… on every request. Without a valid key it answers 401.
To try the tools by hand, run the MCP Inspector, choose Streamable HTTP, enter the URL and add the header:
npx @modelcontextprotocol/inspectorTools
- list_sitesThe sites in your organisation, with install status and last event.
- get_weekly_reportA weekly report: the lede, ranked reasons, the fixes and their estimated impact.
- get_exit_reasonsWhy serious visitors left over a range, with share, pages and estimated impact.
- get_friction_pagesThe pages where serious visits ended, and the top reason on each.
- list_hot_visitorsRecent high-intent visitors, what they looked at and whether they asked for a person.
- list_leadsForm submissions with fit, intent, route and a spam flag.
- explain_sessionOne visit, page by page, with the reason it ended.
- compare_periodsThis period against the last: totals, reasons and pages that moved most.
- create_alert_ruleEmail someone when a visitor reaches an intent level. Needs a key with alerts:write.
Prompt: weekly_briefing, a guided read of the latest weekly report.
Good to know
- Every tool is read-only except
create_alert_rule, which needs a key with thealerts:writescope. - Tools take an optional
siteId. Leave it out and they use your organisation’s first site; ask “list my sites” to pick another. - The same rate limits as the API apply: 60 requests a minute and 10,000 a day per key. See the API reference.
- Revoking a key in Settings → API disconnects every assistant using it at once.