How do I find my Heap App ID and API Key?

Log in to Heap, go to **Account > Projects**, and select your project. Your **App ID** will be visible there. For the **API Key**, navigate to the API section in your project settings to generate a server-side key.

Can I track events server-side through this integration?

Yes! Use the `track_event` tool. You provide the user identity, event name, and optional properties. This is perfect for capturing actions that happen outside the client browser.

How do I update user properties in bulk?

Use the `bulk_add_user_properties` tool. You must provide a JSON array containing objects with `identity` and `properties` for each user you wish to update.

Is the data deletion tool permanent?

Yes. The `delete_user_data` tool triggers a permanent deletion of the user identity and all historical data from Heap, helping you comply with GDPR and CCPA requests.

Heap MCP Server for Pydantic AI 12 tools — connect in under 2 minutes

Name: Heap
Availability: InStock
Author: Vinkius

ai.pydantic.dev/mcp

Built by Vinkius GDPR 12 Tools SDK

Pydantic AI brings type-safe agent development to Python with first-class MCP support. Connect Heap through Vinkius and every tool is automatically validated against Pydantic schemas. catch errors at build time, not in production.

Get MCP Server for AI Agents

ASK AI ABOUT THIS MCP SERVER

Open in ChatGPT Open in Claude Open in Perplexity

Vinkius supports streamable HTTP and SSE.

python

import asyncio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerHTTP

async def main():
    # Your Vinkius token. get it at cloud.vinkius.com
    server = MCPServerHTTP(url="https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")

    agent = Agent(
        model="openai:gpt-4o",
        mcp_servers=[server],
        system_prompt=(
            "You are an assistant with access to Heap "
            "(12 tools)."
        ),
    )

    result = await agent.run(
        "What tools are available in Heap?"
    )
    print(result.data)

asyncio.run(main())

Fully ManagedVinkius Servers

60%Token savings

High SecurityEnterprise-grade

IAMAccess control

EU AI ActCompliant

DLPData protection

V8 IsolateSandboxed

Ed25519Audit chain

<40msKill switch

Stream every event to Splunk, Datadog, or your own webhook in real-time

* Every MCP server runs on Vinkius-managed infrastructure inside AWS - a purpose-built runtime with per-request V8 isolates, Ed25519 signed audit chains, and sub-40ms cold starts optimized for native MCP execution. See our infrastructure

About Heap MCP Server

Connect your Heap.io analytics account to any AI agent and take full control of your product data and user identity management through natural conversation.

Pydantic AI validates every Heap tool response against typed schemas, catching data inconsistencies at build time. Connect 12 tools through Vinkius and switch between OpenAI, Anthropic, or Gemini without changing your integration code. full type safety, structured output guarantees, and dependency injection for testable agents.

What you can do

Event Tracking — Send custom server-side events to Heap to capture granular user interactions.
User Identification — Associate anonymous sessions with specific identities and set custom profile properties.
Segment Management — List all segments defined in your project to understand your user cohorts.
Event Definitions — Access your custom event definitions to stay aligned with your analytics schema.
Bulk Operations — Track multiple events or update several user profiles in a single high-throughput request.
GDPR Compliance — Permanently delete user data directly from the chat interface when requested.
Query Profiles — Filter and retrieve user profiles based on specific behavior or attributes.

The Heap MCP Server exposes 12 tools through the Vinkius. Connect it to Pydantic AI in under two minutes — no API keys to rotate, no infrastructure to provision, no vendor lock-in. Your configuration, your data, your control.

How to Connect Heap to Pydantic AI via MCP

Follow these steps to integrate the Heap MCP Server with Pydantic AI.

Install Pydantic AI

Run pip install pydantic-ai

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token

Run the agent

Save to agent.py and run: python agent.py

Explore tools

The agent discovers 12 tools from Heap with type-safe schemas

Why Use Pydantic AI with the Heap MCP Server

Pydantic AI provides unique advantages when paired with Heap through the Model Context Protocol.

Full type safety: every MCP tool response is validated against Pydantic models, catching data inconsistencies before they reach your application

Model-agnostic architecture. switch between OpenAI, Anthropic, or Gemini without changing your Heap integration code

Structured output guarantee: Pydantic AI ensures tool results conform to defined schemas, eliminating runtime type errors

Dependency injection system cleanly separates your Heap connection logic from agent behavior for testable, maintainable code

Heap + Pydantic AI Use Cases

Practical scenarios where Pydantic AI combined with the Heap MCP Server delivers measurable value.

Type-safe data pipelines: query Heap with guaranteed response schemas, feeding validated data into downstream processing

API orchestration: chain multiple Heap tool calls with Pydantic validation at each step to ensure data integrity end-to-end

Production monitoring: build validated alert agents that query Heap and output structured, schema-compliant notifications

Testing and QA: use Pydantic AI's dependency injection to mock Heap responses and write comprehensive agent tests

Heap MCP Tools for Pydantic AI (12)

These 12 tools become available when you connect Heap to Pydantic AI via MCP:

add_account_properties

Add or update properties for an account (group of users)

add_user_properties

Add or update custom properties for a user profile

bulk_add_user_properties

Update properties for multiple users in a single request

bulk_track_events

Track multiple events concurrently for high-throughput

delete_user_data

Permanently delete a user and all their associated data (GDPR)

get_api_usage

Check current API usage and project status

get_event_definitions

List all custom event definitions in Heap

get_my_profile

Get information about the authenticated API key

get_segments

List all segments defined in your Heap project

identify_user

Associate an anonymous session with a specific user identity

query_user_profiles

Query and filter user profiles based on criteria

track_event

Properties should be a JSON string. Track a server-side event for a user in Heap

Example Prompts for Heap in Pydantic AI

Ready-to-use prompts you can give your Pydantic AI agent to start working with Heap immediately.

"Track event 'Checkout Started' for user 'user_992' with properties {'value': 49.99}."

"List all active segments in the project."

"Identify user 'anon_552' as 'john.doe@example.com'."

Troubleshooting Heap MCP Server with Pydantic AI

Common issues when connecting Heap to Pydantic AI through the Vinkius, and how to resolve them.

MCPServerHTTP not found

Update: pip install --upgrade pydantic-ai

Heap + Pydantic AI FAQ

Common questions about integrating Heap MCP Server with Pydantic AI.

How does Pydantic AI discover MCP tools?

Create an MCPServerHTTP instance with the server URL. Pydantic AI connects, discovers all tools, and generates typed Python interfaces automatically.

Does Pydantic AI validate MCP tool responses?

Yes. When you define result types as Pydantic models, every tool response is validated against the schema. Invalid data raises a clear error instead of silently corrupting your pipeline.

Can I switch LLM providers without changing MCP code?

Absolutely. Pydantic AI abstracts the model layer. your Heap MCP integration works identically with OpenAI, Anthropic, Google, or any supported provider.