Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bavlio.com/llms.txt

Use this file to discover all available pages before exploring further.

Bavlio exposes two distinct MCP surfaces:

Docs MCP — live today

Lets agents query the Bavlio documentation by tool calls (search, fetch page). Auto-generated from this site.

API-action MCP — roadmap

Lets agents take actions against the live Bavlio API (create campaigns, send email, search leads). Planned.

Docs MCP — live

Auto-published by the docs platform at:
https://bavlio.mintlify.app/mcp
Use cases: any agent that needs to consult Bavlio’s documentation (e.g., a Cursor session writing integration code, a Claude Desktop session debugging a 401, an autonomous agent learning the API surface). The MCP server exposes search and page-fetch tools that read this site directly.

Quick install (Cursor)

Add to your Cursor MCP config:
{
  "mcpServers": {
    "bavlio-docs": {
      "url": "https://bavlio.mintlify.app/mcp"
    }
  }
}

Quick install (Claude Desktop)

Open Claude Desktop’s MCP config and add:
{
  "mcpServers": {
    "bavlio-docs": {
      "transport": { "type": "http", "url": "https://bavlio.mintlify.app/mcp" }
    }
  }
}

What this covers vs. doesn’t

Covers: every page on this site — Quickstart, Authentication, Errors, Pagination, Rate Limits, Webhooks, the full API Reference (190 endpoints with request/response schemas), and the OpenAPI spec. Doesn’t cover: taking actions against the API. Agents using only the docs MCP can read docs but can’t, for example, create a campaign or send an email. For that you need the API-action MCP below — or just call the REST API directly with a bav_live_ key.

API-action MCP — roadmap

Status: not yet available. The endpoint, package, and tool surface below are previews — the API-action MCP is not yet shipped. Do not paste the install command yet; it will fail.
A separate MCP server that wraps the Bavlio REST API as agent-callable tools. Lets an agent create campaigns, send emails, search leads, etc. without writing HTTP plumbing.

Planned install path

npx add-mcp https://mcp.bavlio.com/mcp
Transport: Streamable HTTP. Auth: Bearer token using your existing bav_live_ API key.

Planned tool surface

Initial tool set targets the most common agent workflows: campaign lifecycle, lead management, send + reply, plus the two stateless email primitives.
ToolRead-onlyDestructiveIdempotentDescription
list_campaignsyesnoyesList campaigns with optional status filter.
create_campaignnononoCreate a new campaign in DRAFT state.
launch_campaignnonoyesLaunch a DRAFT campaign after preflight checks pass.
pause_campaignnonoyesPause an active campaign.
search_leadsyesnoyesSearch leads in a campaign by name, company, or status.
add_leads_to_campaignnononoAppend leads to a campaign from a CSV/JSON payload.
send_emailnononoSend a transactional email via the BaviMail proxy.
list_repliesyesnoyesList recent inbound replies (untrusted-content envelope).
get_campaign_statsyesnoyesAggregate campaign metrics (sent, delivered, opened, replied).
verify_emailyesnoyesSMTP-probe an email address; returns valid/invalid/risky.

Design notes

  • Untrusted-content envelope. Tools that surface third-party content (inbound replies) wrap responses in { __untrusted_third_party_content: true, content: ... }. The fence is a machine-readable signal that a trust boundary was crossed. Same pattern as @bavimail/mcp-server.
  • No client-side caching of API keys. The server reads the API key on every call; key rotation takes effect without restart.
  • Tool annotations. Every tool ships with readOnlyHint, destructiveHint, and idempotentHint per the MCP spec.

Until then

Use the REST API directly. The Quickstart covers everything an agent needs. The API-action MCP is a convenience layer on top — the underlying capability is already available today via REST.