# How to integrate Beaconstac MCP with Pydantic AI ```json { "title": "How to integrate Beaconstac MCP with Pydantic AI", "toolkit": "Beaconstac", "toolkit_slug": "beaconstac", "framework": "Pydantic AI", "framework_slug": "pydantic-ai", "url": "https://composio.dev/toolkits/beaconstac/framework/pydantic-ai", "markdown_url": "https://composio.dev/toolkits/beaconstac/framework/pydantic-ai.md", "updated_at": "2026-05-06T08:02:18.065Z" } ``` ## Introduction This guide walks you through connecting Beaconstac to Pydantic AI using the Composio tool router. By the end, you'll have a working Beaconstac agent that can create a qr code template for event tickets, list all physical places registered for your brand, delete an outdated qr code template through natural language commands. This guide will help you understand how to give your Pydantic AI agent real control over a Beaconstac account through Composio's Beaconstac MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Beaconstac with - [OpenAI Agents SDK](https://composio.dev/toolkits/beaconstac/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/beaconstac/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/beaconstac/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/beaconstac/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/beaconstac/framework/codex) - [OpenClaw](https://composio.dev/toolkits/beaconstac/framework/openclaw) - [Hermes](https://composio.dev/toolkits/beaconstac/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/beaconstac/framework/cli) - [Google ADK](https://composio.dev/toolkits/beaconstac/framework/google-adk) - [LangChain](https://composio.dev/toolkits/beaconstac/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/beaconstac/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/beaconstac/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/beaconstac/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/beaconstac/framework/crew-ai) ## TL;DR Here's what you'll learn: - How to set up your Composio API key and User ID - How to create a Composio Tool Router session for Beaconstac - How to attach an MCP Server to a Pydantic AI agent - How to stream responses and maintain chat history - How to build a simple REPL-style chat interface to test your Beaconstac workflows ## What is Pydantic AI? Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications. Key features include: - Type Safety: Built on Pydantic for automatic data validation - MCP Support: Native support for Model Context Protocol servers - Streaming: Built-in support for streaming responses - Async First: Designed for async/await patterns ## What is the Beaconstac MCP server, and what's possible with it? The Beaconstac MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Beaconstac account. It provides structured and secure access to your QR code and proximity marketing assets, so your agent can perform actions like creating QR templates, managing places and tags, and organizing collections on your behalf. - QR code template creation and management: Easily instruct your agent to create new QR code templates or delete outdated ones, streamlining your marketing campaigns. - Place and location asset organization: Let your agent register new places or list all your locations for precise proximity marketing management. - Bulk QR code collection browsing: Have your agent search, filter, and organize your bulk QR code collections to keep assets accessible and sorted. - Tagging and categorization automation: Direct your agent to create or delete tags, making it simple to categorize and organize QR codes and related objects. - Organization and user management: Enable your agent to list organizations, onboard new users, or manage access for streamlined account administration. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `BEACONSTAC_CREATE_PLACE` | Create Place | Tool to create a new place for location-based assets. use when you need to register a new physical place under an organization. | | `BEACONSTAC_CREATE_QR_TEMPLATE` | Create QR Template | Tool to create a new qr code template. use when you need reusable design presets for qr codes. | | `BEACONSTAC_CREATE_TAG` | Create Tag | Tool to create a new tag for organizing qr codes and other objects. use when you need to categorize qr codes under a specific organization. | | `BEACONSTAC_CREATE_USER` | Create User | Tool to create a new user. use when onboarding a new user under your organization (reseller plan and above). | | `BEACONSTAC_DELETE_QR_CODE` | Delete QR Code | Tool to delete a qr code by its id. use when you need to remove an existing qr code after validation. | | `BEACONSTAC_DELETE_QR_TEMPLATE` | Delete QR Code Template | Tool to delete a qr code template by its id. use when you need to permanently remove a qr code template that is no longer needed. | | `BEACONSTAC_DELETE_TAG` | Delete Tag | Tool to delete a tag by its id. use when you need to remove an existing tag after validation. | | `BEACONSTAC_LIST_BULK_QR_CODES` | List Bulk QR Code Collections | Tool to list bulk qr code collections. use when you need to filter, search, or order your bulk qr code collections. | | `BEACONSTAC_LIST_ORGANIZATIONS` | List Organizations | Tool to list organizations. use when you need to fetch all organizations accessible to the authenticated account. | | `BEACONSTAC_LIST_PLACES` | List Places | Tool to list your places. use when you need to browse or search your account's places with filtering and ordering. | | `BEACONSTAC_LIST_QR_TEMPLATES` | List QR Templates | Tool to list all qr code templates in your account. use when you need to filter and paginate templates. | | `BEACONSTAC_LIST_TAGS` | List Tags | Tool to list all tags with optional filtering and pagination. use when you need to browse or search tags in your account. | | `BEACONSTAC_LIST_USERS` | List Users | Tool to list all users with optional filtering, searching, ordering, and pagination. use when you need to retrieve user records across your organization. | | `BEACONSTAC_PERIOD_OVERVIEW` | Get Period Overview | Tool to get period overview analytics for products including counts, impressions, and conversion percentage. use after specifying the product type and time interval. | | `BEACONSTAC_PRODUCT_OVERVIEW` | Get Product Overview | Tool to get analytics overview for a specified product type over a given time interval. use after specifying the product type and time range to obtain summary metrics. | | `BEACONSTAC_RETRIEVE_QR_CODE` | Retrieve QR Code | Tool to retrieve details of a specific qr code by its id. use when you need to fetch or verify qr code properties after creation or update. | | `BEACONSTAC_RETRIEVE_USER` | Retrieve User | Tool to retrieve the details of an existing user by id. use when you need to fetch a user's profile after confirming its existence. | | `BEACONSTAC_UPDATE_PLACE` | Update Place | Tool to update the specified place by id. use after retrieving the place to modify its details, such as name, address, or coordinates. | | `BEACONSTAC_UPDATE_QR_CODE` | Update QR Code | Tool to update an existing qr code by its id. use when you need to modify qr code attributes; only provided fields are changed. | | `BEACONSTAC_UPDATE_TAG` | Update Tag | Tool to update an existing tag by its id. use when you need to modify a tag's name or color after confirming its id via list tags. | | `BEACONSTAC_UPDATE_USER` | Update User | Tool to update an existing user. use when you need to modify profile details or organization of a user by their id. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Beaconstac MCP server is an implementation of the Model Context Protocol that connects your AI agent to Beaconstac. It provides structured and secure access so your agent can perform Beaconstac operations on your behalf through a secure, permission-based interface. With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster. ## Step-by-step Guide ### 1. Prerequisites Before starting, make sure you have: - Python 3.9 or higher - A Composio account with an active API key - Basic familiarity with Python and async programming ### 1. Getting API Keys for OpenAI and Composio OpenAI API Key - Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) and create an API key. You'll need credits to use the models, or you can connect to another model provider. - Keep the API key safe. Composio API Key - Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs). - Navigate to your API settings and generate a new API key. - Store this key securely as you'll need it for authentication. ### 2. Install dependencies Install the required libraries. What's happening: - composio connects your agent to external SaaS tools like Beaconstac - pydantic-ai lets you create structured AI agents with tool support - python-dotenv loads your environment variables securely from a .env file ```bash pip install composio pydantic-ai python-dotenv ``` ### 3. Set up environment variables Create a .env file in your project root. What's happening: - COMPOSIO_API_KEY authenticates your agent to Composio's API - USER_ID associates your session with your account for secure tool access - OPENAI_API_KEY to access OpenAI LLMs ```bash COMPOSIO_API_KEY=your_composio_api_key_here USER_ID=your_user_id_here OPENAI_API_KEY=your_openai_api_key ``` ### 4. Import dependencies What's happening: - We load environment variables and import required modules - Composio manages connections to Beaconstac - MCPServerStreamableHTTP connects to the Beaconstac MCP server endpoint - Agent from Pydantic AI lets you define and run the AI assistant ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from pydantic_ai import Agent from pydantic_ai.mcp import MCPServerStreamableHTTP load_dotenv() ``` ### 5. Create a Tool Router Session What's happening: - We're creating a Tool Router session that gives your agent access to Beaconstac tools - The create method takes the user ID and specifies which toolkits should be available - The returned session.mcp.url is the MCP server URL that your agent will use ```python async def main(): api_key = os.getenv("COMPOSIO_API_KEY") user_id = os.getenv("USER_ID") if not api_key or not user_id: raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment") # Create a Composio Tool Router session for Beaconstac composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["beaconstac"], ) url = session.mcp.url if not url: raise ValueError("Composio session did not return an MCP URL") ``` ### 6. Initialize the Pydantic AI Agent What's happening: - The MCP client connects to the Beaconstac endpoint - The agent uses GPT-5 to interpret user commands and perform Beaconstac operations - The instructions field defines the agent's role and behavior ```python # Attach the MCP server to a Pydantic AI Agent beaconstac_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[beaconstac_mcp], instructions=( "You are a Beaconstac assistant. Use Beaconstac tools to help users " "with their requests. Ask clarifying questions when needed." ), ) ``` ### 7. Build the chat interface What's happening: - The agent reads input from the terminal and streams its response - Beaconstac API calls happen automatically under the hood - The model keeps conversation history to maintain context across turns ```python # Simple REPL with message history history = [] print("Chat started! Type 'exit' or 'quit' to end.\n") print("Try asking the agent to help you with Beaconstac.\n") while True: user_input = input("You: ").strip() if user_input.lower() in {"exit", "quit", "bye"}: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n", flush=True) async with agent.run_stream(user_input, message_history=history) as stream_result: collected_text = "" async for chunk in stream_result.stream_output(): text_piece = None if isinstance(chunk, str): text_piece = chunk elif hasattr(chunk, "delta") and isinstance(chunk.delta, str): text_piece = chunk.delta elif hasattr(chunk, "text"): text_piece = chunk.text if text_piece: collected_text += text_piece result = stream_result print(f"Agent: {collected_text}\n") history = result.all_messages() ``` ### 8. Run the application What's happening: - The asyncio loop launches the agent and keeps it running until you exit ```python if __name__ == "__main__": asyncio.run(main()) ``` ## Complete Code ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from pydantic_ai import Agent from pydantic_ai.mcp import MCPServerStreamableHTTP load_dotenv() async def main(): api_key = os.getenv("COMPOSIO_API_KEY") user_id = os.getenv("USER_ID") if not api_key or not user_id: raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment") # Create a Composio Tool Router session for Beaconstac composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["beaconstac"], ) url = session.mcp.url if not url: raise ValueError("Composio session did not return an MCP URL") # Attach the MCP server to a Pydantic AI Agent beaconstac_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[beaconstac_mcp], instructions=( "You are a Beaconstac assistant. Use Beaconstac tools to help users " "with their requests. Ask clarifying questions when needed." ), ) # Simple REPL with message history history = [] print("Chat started! Type 'exit' or 'quit' to end.\n") print("Try asking the agent to help you with Beaconstac.\n") while True: user_input = input("You: ").strip() if user_input.lower() in {"exit", "quit", "bye"}: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n", flush=True) async with agent.run_stream(user_input, message_history=history) as stream_result: collected_text = "" async for chunk in stream_result.stream_output(): text_piece = None if isinstance(chunk, str): text_piece = chunk elif hasattr(chunk, "delta") and isinstance(chunk.delta, str): text_piece = chunk.delta elif hasattr(chunk, "text"): text_piece = chunk.text if text_piece: collected_text += text_piece result = stream_result print(f"Agent: {collected_text}\n") history = result.all_messages() if __name__ == "__main__": asyncio.run(main()) ``` ## Conclusion You've built a Pydantic AI agent that can interact with Beaconstac through Composio's Tool Router. With this setup, your agent can perform real Beaconstac actions through natural language. You can extend this further by: - Adding other toolkits like Gmail, HubSpot, or Salesforce - Building a web-based chat interface around this agent - Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Beaconstac for workflow automation) This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations. ## How to build Beaconstac MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/beaconstac/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/beaconstac/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/beaconstac/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/beaconstac/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/beaconstac/framework/codex) - [OpenClaw](https://composio.dev/toolkits/beaconstac/framework/openclaw) - [Hermes](https://composio.dev/toolkits/beaconstac/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/beaconstac/framework/cli) - [Google ADK](https://composio.dev/toolkits/beaconstac/framework/google-adk) - [LangChain](https://composio.dev/toolkits/beaconstac/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/beaconstac/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/beaconstac/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/beaconstac/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/beaconstac/framework/crew-ai) ## Related Toolkits - [Metaads](https://composio.dev/toolkits/metaads) - Metaads is Meta's official Ads API that lets you manage, analyze, and optimize your Facebook and Instagram ad campaigns. Streamline ad operations and gain deeper insights with robust automation. - [Adrapid](https://composio.dev/toolkits/adrapid) - Adrapid is a platform for rapid creation of digital marketing visuals using templates. It streamlines design workflows for banners, images, and HTML5 content with automation. - [Adyntel](https://composio.dev/toolkits/adyntel) - Adyntel is an API that retrieves LinkedIn ads for any company using a domain or LinkedIn Page ID. Easily access competitive ad intelligence to power your marketing workflows. - [Campaign cleaner](https://composio.dev/toolkits/campaign_cleaner) - Campaign cleaner is an email campaign optimization tool that boosts compatibility and deliverability across email clients. It helps marketers get better results by cleaning, enhancing, and ensuring high performance for every campaign. - [Deadline funnel](https://composio.dev/toolkits/deadline_funnel) - Deadline Funnel lets you create personalized deadlines and timers for your marketing campaigns. It helps marketers boost conversions by adding authentic urgency to offers. - [Google Ads](https://composio.dev/toolkits/googleads) - Google Ads is Google's online advertising platform for creating, managing, and optimizing digital campaigns. It helps businesses reach targeted customers and maximize return on ad spend. - [Instantly](https://composio.dev/toolkits/instantly) - Instantly is a platform for automating cold email outreach, managing leads, and optimizing deliverability. Get better results from email campaigns with minimal manual effort. - [Proofly](https://composio.dev/toolkits/proofly) - Proofly is a social proof platform that displays real-time notifications of customer activity on your site. It helps you increase website conversions by building trust and urgency for visitors. - [Segmetrics](https://composio.dev/toolkits/segmetrics) - Segmetrics is a marketing analytics platform that reveals detailed insights into your customer journeys. It helps businesses optimize marketing strategies with accurate, actionable reporting. - [Semrush](https://composio.dev/toolkits/semrush) - Semrush is a leading SEO tool suite for keyword research, competitor analysis, and campaign tracking. It empowers marketers to improve search rankings and optimize online visibility. - [Sendloop](https://composio.dev/toolkits/sendloop) - Sendloop is an all-in-one email marketing platform built for SaaS, e-commerce, and small businesses. It makes it easy to send campaigns, manage lists, and track results—all in one place. - [Sidetracker](https://composio.dev/toolkits/sidetracker) - Sidetracker is a marketing analytics platform that tracks expenses, sales funnels, and customer journeys. It helps optimize marketing spend and visualize campaign performance from start to finish. - [Stannp](https://composio.dev/toolkits/stannp) - Stannp is an API-driven direct mail platform for sending postcards and letters programmatically. It lets you automate physical mail delivery—no manual printing or mailing required. - [Tapfiliate](https://composio.dev/toolkits/tapfiliate) - Tapfiliate is an affiliate and referral tracking platform for businesses. It helps companies efficiently manage, track, and grow their affiliate programs. - [Tpscheck](https://composio.dev/toolkits/tpscheck) - Tpscheck is a real-time service for verifying UK phone numbers against TPS and CTPS registers. It helps prevent unwanted marketing calls and ensures compliance with UK telemarketing laws. - [Gmail](https://composio.dev/toolkits/gmail) - Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable. - [Google Calendar](https://composio.dev/toolkits/googlecalendar) - Google Calendar is a time management service for scheduling meetings, events, and reminders. It streamlines personal and team organization with integrated notifications and sharing options. - [Google Drive](https://composio.dev/toolkits/googledrive) - Google Drive is a cloud storage platform for uploading, sharing, and collaborating on files. It's perfect for keeping your documents accessible and organized across devices. - [Outlook](https://composio.dev/toolkits/outlook) - Outlook is Microsoft's email and calendaring platform for unified communications and scheduling. It helps users stay organized with powerful email, contacts, and calendar management. - [Twitter](https://composio.dev/toolkits/twitter) - Twitter is a social media platform for sharing real-time updates, conversations, and news. Stay connected, informed, and engaged with communities worldwide. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Beaconstac MCP? With a standalone Beaconstac MCP server, the agents and LLMs can only access a fixed set of Beaconstac tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Beaconstac and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Pydantic AI? Yes, you can. Pydantic AI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Beaconstac tools. ### Can I manage the permissions and scopes for Beaconstac while using Tool Router? Yes, absolutely. You can configure which Beaconstac scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do. ### How safe is my data with Composio Tool Router? All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Beaconstac data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)