MCP Integration

Beta Feature

MCP Integration is currently in beta. The available tools and configuration format may change in future releases.

Overview

MaestroHub exposes a Model Context Protocol (MCP) server that lets AI coding assistants interact directly with your industrial automation platform. Once connected, an AI assistant can query connections, build pipelines, publish data to the Unified Namespace, create dashboards, and more — all through natural language.

This enables use cases such as:

• Rapid prototyping — describe a pipeline in plain English and have the AI build it
• Data exploration — ask questions about your UNS topics, connections, and pipeline executions
• Dashboard creation — generate monitoring dashboards from conversational descriptions
• Troubleshooting — inspect connection statuses, execution logs, and dependency graphs with AI assistance

Prerequisites

• OAuth2 module enabled — The MCP server authenticates via Personal Access Tokens (PATs), which require the OAuth2 module
• A Personal Access Token — Generated from your profile page (see below)

Step 1: Generate a Personal Access Token

Create a PAT from your profile's Security tab. Give it a descriptive name (e.g., "MCP - Claude Code"), select an expiration period (1 year recommended for development use), and grant the permissions needed for your workflow.

For detailed instructions, see Personal Access Tokens.

Step 2: Obtain the Organization ID

Most MCP configurations require an Organization ID to scope API requests to the correct organization.

For how to find and copy your Organization ID, see Organization Context.

Step 3: Configure Your Editor

Choose your editor from the guides below to set up MCP integration:

• Claude Code
• Claude Desktop App
• Cursor
• VS Code
• Antigravity
• Codex
• Microsoft Copilot Studio

Each guide provides the exact configuration file format and location for the editor.

For real-world prompt examples with actual outputs, see the Example Prompts page. For a full end-to-end walkthrough, see Walkthrough: Antigravity + Gemini.

Available Tools

The MCP server exposes 21 consolidated tools, each supporting multiple actions via an action parameter. Tools are grouped by module.

Connectors

Tool	Actions	Description
manage_connections	list, get, create, update, test, start, stop	Manage data source/destination connections — CRUD, connectivity testing, and lifecycle control
monitor_connections	status, state_history, health_summary	Monitor connection health, state transitions, and aggregated reliability stats
manage_functions	list, get, create, update, execute	Manage and execute connector functions (queries, API calls, pub/sub)
explore_protocols	list, get	Discover available connection protocols and their configuration schemas

Pipeline Engine

Tool	Actions	Description
manage_pipelines	list, get, create, update, enable, disable, validate	Manage data pipelines — CRUD, lifecycle control, and validation
query_executions	list, get	Query pipeline execution history and details
explore_node_types	list, get	Discover available pipeline node types and their configuration schemas
manage_models	list, get	View data models that define schemas for pipeline data

Unified Namespace (UNS)

Tool	Actions	Description
manage_topics	list, search, get, create	Manage UNS topics with hierarchical naming
query_topic_data	publish, fetch_recent, fetch_range, broker_status	Publish and query data on UNS topics, check MQTT broker status

Dashboards

Tool	Actions	Description
manage_dashboards	list, get, create, update, delete	Manage UNS dashboards — CRUD with grid layout, time ranges, and variables
manage_panels	list_types, get_type, add, update, remove	Manage dashboard panels and discover available panel types

Dependencies

Tool	Actions	Description
query_dependencies	graph, dependents, dependencies, impact, orphans, insights, stats, node	Query the dependency graph — relationships, impact analysis, orphans, and insights

Authentication & Authorization

Tool	Actions	Description
manage_users	list, get, stats	View users and user statistics
list_identity_providers	—	List configured SSO identity providers (OIDC, LDAP, SAML)
manage_access	list_roles, user_roles, role_members, check	Query roles, role assignments, and access permissions

Organization & License

Tool	Actions	Description
manage_organizations	list, get, settings, maintenance_status, settings_history	View organization details, settings, and maintenance status
manage_license	status, features, history, check_feature	View license status, enabled features, and history

Scheduler & Search

Tool	Actions	Description
manage_scheduler	stats, trigger, list_webhooks	View scheduler status, trigger pipelines, and list webhook endpoints
search	query, find_by_id, stats	Search across all entity types (pipelines, connections, functions, topics, models, dashboards)

System Status

Tool	Actions	Description
get_system_status	websocket, presence	Get WebSocket server status and pipeline editor presence

Tips & Best Practices

• HTTP vs HTTPS — The examples in these guides use https://. If your MaestroHub instance is deployed locally without TLS (e.g., http://localhost:8080), replace https:// with http:// in the MCP server URL.
• Token management — Rotate tokens periodically and use a 1-year expiration for development.
• Organization context — The X-Organization-ID header determines which organization's data the AI can access. Make sure it matches your target environment.
• Tool discovery — Ask the AI "What MCP tools are available?" to get a full list of capabilities. The AI can also call explore_node_types and explore_protocols to discover what pipeline nodes and connector types are supported.
• Iterative building — Start with simple pipelines and add complexity incrementally. The AI can update existing pipelines with manage_pipelines (action: update).
• Impact analysis — Before modifying or deleting a connection or function, ask the AI to run query_dependencies with action impact to understand what will be affected.