> ## Documentation Index
> Fetch the complete documentation index at: https://heybtw.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP Tools

> Connect heyBTW to Claude, ChatGPT, or any MCP-compatible agent and query your event intelligence, partner insights, and attribution programmatically.

MCP (Model Context Protocol) lets you connect heyBTW to AI agents like Claude, ChatGPT, or a custom agent system. Once connected, your agent can query your event data, partner relationships, attribution, and cross-event patterns in natural language.

Read tools are available on every plan, including Free. Write tools are available on Enterprise.

## Setup

### Generate an API key

1. Click your account name in the bottom-left sidebar to open the account menu.
2. Select **API Keys**.
3. Click **Generate API Key** to create a workspace-scoped key. The key starts with `hbtw_ws_` and is tied to your workspace, not to an individual user.

You can regenerate or revoke the key at any time from this page, which also shows when the key was created and last used.

### Connect your agent

The API Keys page includes a ready-to-copy configuration snippet for Claude Desktop. Expand the **Connect to Claude Desktop** section and copy the JSON config block. It uses `npx mcp-remote` to reach the heyBTW MCP server with Bearer token authentication.

Paste the config into your client's configuration file. For Claude Desktop:

* macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
* Windows: `%APPDATA%\Claude\claude_desktop_config.json`

Replace `<your-key>` with your actual API key. Any MCP-compatible client connects the same way: point it at the heyBTW MCP server with the key as a Bearer token.

### Restart and verify

Restart your client. heyBTW tools will appear as available MCP tools in your conversations.

## Join heyBTW with your CRM through MCP

This is the pattern security-conscious enterprises reach for. You do not have to connect your CRM to heyBTW at all. Instead, run two MCP servers behind your agent: heyBTW's, for event attendance and relationship intelligence, and your CRM's own MCP server (Salesforce, HubSpot, or Attio), for pipeline data.

Your agent does the join. heyBTW never connects to or receives your CRM data. heyBTW supplies the relationship and event-attendance layer, your CRM keeps the pipeline, and the agent cross-references the two to produce attribution that neither system could generate alone. See [CRM](/docs/integrations/crm) for the direct-connection alternative.

## Available tools

heyBTW exposes eight read tools today. All tools are workspace-scoped, meaning they only return data from your workspace. The workspace is determined by your API key, never passed as a parameter. Each tool below links to a full reference page with its complete parameter table, a real sample response, and a field-by-field breakdown — read the reference page before building a parser against a tool's output.

### [get\_workspace\_overview](/docs/mcp-tools/get-workspace-overview)

Program health and agent capability discovery. Call this first in a new session — it tells you which integrations are connected and which other tools will return real data versus an empty/degraded result.

* **When to use it.** "What can I ask about this workspace?" or as the first call before anything else.
* **Parameters.** `date_from` (optional).

### [get\_account\_relationship](/docs/mcp-tools/get-account-relationship)

Full Context Graph profile for one account: event history, contacts with seniority, warm intro paths, engagement trajectory, and CRM pipeline context.

* **When to use it.** "Tell me everything about Zynga" or "Give me a profile on stripe.com."
* **Parameters.** `domain` (preferred) or `account_name` — one required. `limit` (optional, default 50).

### [get\_partner\_insights](/docs/mcp-tools/get-partner-insights)

Partner influence data: sourcing breakdown, seniority profile, funnel rates, and pipeline impact per partner.

* **When to use it.** "Which partners have a relationship with a target account we could leverage for a warm intro?"
* **Parameters.** `partner_name` (optional), `partner_domain` (optional), `include_archived` (optional, default false).

### [get\_event\_attribution](/docs/mcp-tools/get-event-attribution)

Attribution data connecting events to pipeline outcomes. Classifications follow the [Attribution Model](/docs/concepts/attribution-model): every deal is [Sourced](/docs/getting-started/glossary#sourced) or [Influenced](/docs/getting-started/glossary#influenced).

* **When to use it.** "Which deals can we attribute to the Berlin Fintech Dinner in March?"
* **Parameters.** `channel_id` (optional, filter to one event), `date_from` (optional), `date_to` (optional).

### [get\_cross\_event\_patterns](/docs/mcp-tools/get-cross-event-patterns)

Multi-event account engagement trajectories: which companies are compounding engagement, and which are cooling off.

* **When to use it.** "Which accounts have attended 3 or more events?"
* **Parameters.** `domain` (optional), `min_events` (optional, default 2), `limit` (optional, default 20), `include_own_domain` / `include_partner_accounts` (optional, default false).

### [get\_invite\_recommendations](/docs/mcp-tools/get-invite-recommendations)

A scored invite list for a specific upcoming event, combining ABM priority, past attendance, and conversion history.

* **When to use it.** "Who should we invite to this event?" once the event exists in heyBTW.
* **Parameters.** `channel_id` (required in practice), `limit` (optional, default 25), `include_own_domain` (optional, default false).

### [get\_event\_summary](/docs/mcp-tools/get-event-summary)

The single-event deep dive: attendance breakdown, seniority distribution, partner performance, top accounts, program comparison, and pipeline for one event.

* **When to use it.** "Give me a report on last month's Robotics Summit."
* **Parameters.** `channel_id` (required), `include_contacts` / `include_partner_breakdown` (optional, default false).

### [query\_event\_intelligence](/docs/mcp-tools/query-event-intelligence)

Cross-event attendance grouped by company, with inline contacts — a lighter-weight sibling to `get_cross_event_patterns` when you want attendee detail in the same call.

* **When to use it.** "What events has Chargebee attended?" or "Show me everyone from stripe.com who's engaged with us."
* **Parameters.** `event_name` (optional), `domain` (optional), `limit` (optional, default 10), `include_own_domain` (optional, default false).

<Note>
  An earlier version of this page also listed a `get_conference_summary` tool. It is not part of this MCP surface. If your integration was built against `get_conference_summary`'s documented shape, it will not work — use `get_event_summary` for single-event reporting.
</Note>

## Response format

Every tool response includes a metadata block with data provenance: which data sources were queried, what date range was applied, which filters were active, and a coverage note about data completeness. This helps the agent communicate data context to the user.

When no data matches your filters, tools return empty results with a clear coverage note. They do not error. An agent should read the coverage note before concluding that something is zero, because a missing data source (for example, an Attio workspace without a deal-created date field) can limit what a query can see.

## Representing attribution honestly

When an agent reports heyBTW attribution, it should phrase claims the way the model intends. Over-claiming Sourced is the fastest way to lose a sophisticated buyer.

* **Lead with Influenced for in-flight pipeline.** It holds up under scrutiny, and it is safe to claim even when the source is null or owned by sales or another channel.
* **Claim Sourced only with strong evidence and provenance.** Never infer Sourced from heyBTW driving the targeting, and never claim Sourced for a sales- or SDR-originated lead. If the source is unclear, the honest claim is Influenced.
* **Always cite provenance.** Name the event, attendee, and timestamps behind a claim.
* **Acceleration is correlation, not causation.** It is a weight on Influenced, in development today. When it ships, describe it as correlating with faster stage progression, never as having caused movement, and always pair it with the Influenced claim.

See the [Attribution Model](/docs/concepts/attribution-model) for the full definitions.

## Schema stability

The tool schemas and the response envelope are a stability commitment, not an implementation detail. The claim shape, dimension names, the Sourced and Influenced rule, and the exclusion rules are stable. Signal weighting nuances and partner sub-hierarchy refinements may evolve. If you build on a specific field, pin to the schema version. Schema discovery is exposed via the MCP and OpenAPI surfaces. See the [Attribution Model](/docs/concepts/attribution-model#stability) for what is stable versus what may change.

## Write tools (Enterprise)

Enterprise plans add write tools so an agent can act, not just read:

* **`push_event_data`.** Import event and attendee data into your workspace from an agent.
* **`confirm_enrichment`.** Approve an enrichment run. Because enrichment spends credits, this is a confirmation step. heyBTW never auto-spends credits.
* **`update_attendee_status`.** Update an attendee's status, for example Approved, Declined, or Waitlist.

## Plans and access

* **Free.** All eight read tools: workspace overview, account relationships, partner insights, attribution, cross-event patterns, invite recommendations, event summaries, and event intelligence.
* **Growth.** Full MCP read access for Claude, ChatGPT, and AI assistants.
* **Enterprise.** Everything in Growth, plus the write tools above and SSO/SAML on the MCP server.

The workspace-scoped API key (`hbtw_ws_...`) grants access to the tools your plan includes. Regenerating the key invalidates the old one immediately.

## Permissions

Read tools are read-only and available on all plans, including Free. They query your workspace data without modifying it. Write tools are available on Enterprise and can create or update records in your workspace. The API key is workspace-scoped and grants access to the tools your plan includes, so treat it like a shared credential. Admins generate and manage the key from **Account > API Keys**.

## Your workspace's domain

By default, your own workspace's domain is excluded from company-level aggregation results. This prevents your own employees from skewing account-level analytics.
