# How to integrate Hotspotsystem MCP with Pydantic AI ```json { "title": "How to integrate Hotspotsystem MCP with Pydantic AI", "toolkit": "Hotspotsystem", "toolkit_slug": "hotspotsystem", "framework": "Pydantic AI", "framework_slug": "pydantic-ai", "url": "https://composio.dev/toolkits/hotspotsystem/framework/pydantic-ai", "markdown_url": "https://composio.dev/toolkits/hotspotsystem/framework/pydantic-ai.md", "updated_at": "2026-05-12T10:15:08.718Z" } ``` ## Introduction This guide walks you through connecting Hotspotsystem to Pydantic AI using the Composio tool router. By the end, you'll have a working Hotspotsystem agent that can list all customers at main street location, generate a single-use voucher for lobby, list paid transactions for downtown hotspot through natural language commands. This guide will help you understand how to give your Pydantic AI agent real control over a Hotspotsystem account through Composio's Hotspotsystem MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Hotspotsystem with - [OpenAI Agents SDK](https://composio.dev/toolkits/hotspotsystem/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/hotspotsystem/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/hotspotsystem/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/hotspotsystem/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/hotspotsystem/framework/codex) - [OpenClaw](https://composio.dev/toolkits/hotspotsystem/framework/openclaw) - [Hermes](https://composio.dev/toolkits/hotspotsystem/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/hotspotsystem/framework/cli) - [Google ADK](https://composio.dev/toolkits/hotspotsystem/framework/google-adk) - [LangChain](https://composio.dev/toolkits/hotspotsystem/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/hotspotsystem/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/hotspotsystem/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/hotspotsystem/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/hotspotsystem/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 Hotspotsystem - 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 Hotspotsystem 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 Hotspotsystem MCP server, and what's possible with it? The Hotspotsystem MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Hotspotsystem account. It provides structured and secure access to your Wi-Fi hotspot management platform, so your agent can perform actions like listing customers, generating access vouchers, monitoring transactions, and managing subscribers across your locations. - Customer and subscriber management: Instantly list all customers or newsletter subscribers, or filter them by specific hotspot locations for targeted communications or support. - On-demand voucher generation: Have your agent create single-use access vouchers for guests or events—automatically and only when there are enough credits. - Location and asset visibility: Retrieve and review all your registered hotspot locations, making it easy to audit or manage distributed sites and devices. - Transaction monitoring and reporting: List MAC-based or paid transactions by location, enabling your agent to provide real-time analytics or billing support for your hotspots. - API health checks and diagnostics: Use the agent to ping the Hotspotsystem API for connectivity checks, ensuring your integrations and automations run smoothly. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `HOTSPOTSYSTEM_CUSTOMERS_LIST` | List Customers | Lists all customers in the HotspotSystem account with optional filtering. Use this tool to: - Retrieve all customers with their details (name, email, contact info, registration date, etc.) - Paginate through large customer lists using limit and offset parameters - Sort customers by any field in ascending or descending order - Filter response to only include specific fields to reduce payload size Returns metadata with total customer count and an array of customer objects. | | `HOTSPOTSYSTEM_CUSTOMERS_LIST_BY_LOCATION` | List Customers by Location | Lists all customers associated with a specific HotspotSystem location. Use this tool to: - Retrieve customer details (name, email, contact info, registration date) for a specific location - Paginate through large customer lists using limit and offset parameters - Sort customers by any field (prepend '-' for descending order, e.g., '-registered_at') - Filter response to include only specific fields to reduce payload size - Query customers at different locations by location ID Returns metadata with total customer count and an array of customer objects. Note: Empty results (total_count: 0) indicate no customers are registered at the specified location. | | `HOTSPOTSYSTEM_GENERATE_VOUCHER_V1` | Generate Voucher (v1) | Generates an access voucher code on-demand for a specific location. This action creates a single-use voucher that can be used for hotspot access. The voucher is generated against available voucher credits in the specified location. Use this when you need to provide immediate access codes to users. Note: Requires an active location with available voucher credits (use the List Locations action first to get valid location_id values). | | `HOTSPOTSYSTEM_GET_LOCATIONS_OPTIONS` | Get Locations Options | Tool to get simplified list of locations as dropdown options. Returns only id/name pairs for each location. Use when you need location options for selection menus or dropdowns. | | `HOTSPOTSYSTEM_GET_ME` | Get Me | Tool to verify the resource owner's credentials and retrieve authenticated user information. Use when you need to confirm authentication status or get the current user's ID and operator name. | | `HOTSPOTSYSTEM_LIST_PAID_TRANSACTIONS` | List Paid Transactions | Tool to list paid transactions globally across all locations. Use when you need to retrieve all paid transaction records with optional pagination and sorting. | | `HOTSPOTSYSTEM_LOCATIONS_LIST` | List Locations | Tool to list the resource owner's locations. Use when you need to retrieve locations with optional filtering, sorting, or pagination. | | `HOTSPOTSYSTEM_MISC_PING` | Misc Ping | Tool to perform health check against the HotspotSystem API. Use when verifying connectivity and availability. | | `HOTSPOTSYSTEM_SUBSCRIBERS_LIST` | List Subscribers | List newsletter subscribers across all locations with optional filtering, sorting, and pagination. Returns subscriber information including contact details (name, email, phone, address) and social network data (Facebook, Google, etc.). Supports field selection to retrieve only needed properties, sorting by any field (ascending or descending), and pagination with limit/offset for large result sets. Use this tool when you need to: - Retrieve all subscribers for the account - Filter subscribers by specific fields - Sort subscribers by registration date, name, email, etc. - Paginate through large subscriber lists | | `HOTSPOTSYSTEM_SUBSCRIBERS_LIST_BY_LOCATION` | List Subscribers by Location | Tool to list subscribers by location. Use when you need to retrieve subscribers for a specific location with optional field selection, sorting, and pagination. | | `HOTSPOTSYSTEM_TRANSACTIONS_LIST_MAC` | List MAC Transactions | Tool to list MAC-based transactions. Use when you need to retrieve MAC transaction records with optional pagination and sorting. | | `HOTSPOTSYSTEM_TRANSACTIONS_LIST_MAC_BY_LOCATION` | List MAC Transactions by Location | Lists MAC address authentication transactions for a specific location. MAC (Media Access Control) transactions track network access granted based on device MAC addresses. Use this action when you need to: - View MAC-based authentication history for a specific location - Monitor which devices accessed the network via MAC authentication - Retrieve transaction records with customer data and custom fields - Filter and paginate MAC transaction records for reporting For transactions across all locations, use the global MAC transactions endpoint instead. | | `HOTSPOTSYSTEM_TRANSACTIONS_LIST_PAID_BY_LOCATION` | List Paid Transactions by Location | Tool to list paid transactions by location. Use when you need to retrieve paid transaction records for a specific location with optional pagination and sorting. | | `HOTSPOTSYSTEM_TRANSACTIONS_LIST_SOCIAL` | List Social Transactions | Tool to list social transactions. Use when you need to retrieve social transaction records with optional pagination and sorting. | | `HOTSPOTSYSTEM_TRANSACTIONS_LIST_SOCIAL_BY_LOCATION` | List Social Transactions by Location | Tool to list social transactions by location. Use when you need to retrieve social transaction records for a specific location with optional pagination and sorting. | | `HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHER` | List Voucher Transactions | Tool to list voucher transactions globally across all locations. | | `HOTSPOTSYSTEM_TRANSACTIONS_LIST_VOUCHER_BY_LOCATION` | List Voucher Transactions by Location | Tool to list voucher transactions by location. Use when you need to retrieve voucher transaction records for a specific location with optional pagination and sorting. | | `HOTSPOTSYSTEM_VOUCHERS_LIST` | List Vouchers | Tool to list the resource owner's vouchers across all locations. Use when you need to retrieve vouchers with optional filtering, sorting, or pagination. | | `HOTSPOTSYSTEM_VOUCHERS_LIST_BY_LOCATION` | Vouchers List by Location | Retrieves all vouchers associated with a specific location in the HotspotSystem. Use this action to: - List all vouchers available at a particular location - Filter voucher results by specific fields - Sort vouchers by any field (e.g., validity, price) - Implement pagination for large voucher lists Each voucher includes details such as serial number, access code, usage limits (traffic/download/upload), validity period, and pricing information. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Hotspotsystem MCP server is an implementation of the Model Context Protocol that connects your AI agent to Hotspotsystem. It provides structured and secure access so your agent can perform Hotspotsystem 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 Hotspotsystem - 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 Hotspotsystem - MCPServerStreamableHTTP connects to the Hotspotsystem 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 Hotspotsystem 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 Hotspotsystem composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["hotspotsystem"], ) 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 Hotspotsystem endpoint - The agent uses GPT-5 to interpret user commands and perform Hotspotsystem operations - The instructions field defines the agent's role and behavior ```python # Attach the MCP server to a Pydantic AI Agent hotspotsystem_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[hotspotsystem_mcp], instructions=( "You are a Hotspotsystem assistant. Use Hotspotsystem 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 - Hotspotsystem 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 Hotspotsystem.\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 Hotspotsystem composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["hotspotsystem"], ) 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 hotspotsystem_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[hotspotsystem_mcp], instructions=( "You are a Hotspotsystem assistant. Use Hotspotsystem 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 Hotspotsystem.\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 Hotspotsystem through Composio's Tool Router. With this setup, your agent can perform real Hotspotsystem 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 + Hotspotsystem 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 Hotspotsystem MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/hotspotsystem/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/hotspotsystem/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/hotspotsystem/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/hotspotsystem/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/hotspotsystem/framework/codex) - [OpenClaw](https://composio.dev/toolkits/hotspotsystem/framework/openclaw) - [Hermes](https://composio.dev/toolkits/hotspotsystem/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/hotspotsystem/framework/cli) - [Google ADK](https://composio.dev/toolkits/hotspotsystem/framework/google-adk) - [LangChain](https://composio.dev/toolkits/hotspotsystem/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/hotspotsystem/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/hotspotsystem/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/hotspotsystem/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/hotspotsystem/framework/crew-ai) ## Related Toolkits - [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. - [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly. - [Supabase](https://composio.dev/toolkits/supabase) - Supabase is an open-source backend platform offering scalable Postgres databases, authentication, storage, and real-time APIs. It lets developers build modern apps without managing infrastructure. - [Composio](https://composio.dev/toolkits/composio) - Composio is an integration platform that connects AI agents with hundreds of business tools. It streamlines authentication and lets you trigger actions across services—no custom code needed. - [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place. - [Slack](https://composio.dev/toolkits/slack) - Slack is a channel-based messaging platform for teams and organizations. It helps people collaborate in real time, share files, and connect all their tools in one place. - [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations. - [Google Docs](https://composio.dev/toolkits/googledocs) - Google Docs is a cloud-based word processor that enables document creation and real-time collaboration. Its seamless sharing and version history make team editing and content management a breeze. - [Google Super](https://composio.dev/toolkits/googlesuper) - Google Super is an all-in-one suite combining Gmail, Drive, Calendar, Sheets, Analytics, and more. It gives you a unified platform to manage your digital life, boosting productivity and organization. - [Hubspot](https://composio.dev/toolkits/hubspot) - HubSpot is an all-in-one marketing, sales, and customer service platform. It lets teams nurture leads, automate outreach, and track every customer interaction in one place. - [Codeinterpreter](https://composio.dev/toolkits/codeinterpreter) - Codeinterpreter is a Python-based coding environment with built-in data analysis and visualization. It lets you instantly run scripts, plot results, and prototype solutions inside supported platforms. - [Gong](https://composio.dev/toolkits/gong) - Gong is a platform for video meetings, call recording, and team collaboration. It helps teams capture conversations, analyze calls, and turn insights into action. - [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals. - [Ashby](https://composio.dev/toolkits/ashby) - Ashby is an applicant tracking system that handles job postings, candidate management, and hiring analytics. - [Pipedrive](https://composio.dev/toolkits/pipedrive) - Pipedrive is a sales management platform offering pipeline visualization, lead tracking, and workflow automation. It helps sales teams keep deals moving forward efficiently and never miss a follow-up. - [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Hotspotsystem MCP? With a standalone Hotspotsystem MCP server, the agents and LLMs can only access a fixed set of Hotspotsystem tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Hotspotsystem 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 Hotspotsystem tools. ### Can I manage the permissions and scopes for Hotspotsystem while using Tool Router? Yes, absolutely. You can configure which Hotspotsystem 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 Hotspotsystem data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)