ignition-mcp

WhiskeyHouse/ignition-mcp

3.3

If you are the rightful owner of ignition-mcp and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The Ignition MCP server is designed to work with the new REST API, providing enhanced capabilities for managing and interacting with industrial automation systems.

Ignition MCP Server

A powerful Model Context Protocol (MCP) server that provides seamless integration with Inductiveautomation's Ignition SCADA/MES platform through its REST API. This enables AI assistants to interact with Ignition Gateway operations for automation, monitoring, and management tasks.

🚀 Features

  • 🔌 Automatic API Integration: Dynamically generates 45+ tools from Ignition's OpenAPI specification
  • 🛡️ Flexible Authentication: Supports both API keys and basic authentication
  • 📊 Real-time Gateway Management: Monitor status, manage projects, handle backups, and more
  • 🎯 MCP Protocol: Full compatibility with Claude Desktop and other MCP clients
  • ⚡ Async Operations: Built on modern async/await patterns for optimal performance
  • 🔧 Comprehensive Toolset: Pre-built tools for activation, backups, logs, modules, and projects

📋 Tool Categories

CategoryToolsDescription
🔐 Activation7 toolsLicense management and gateway activation
💾 Backup2 toolsGateway backup creation and restoration
📋 Logs11 toolsLog retrieval, management, and analysis
📦 Modules10 toolsModule health checks and certificate management
🏗️ Projects12 toolsProject creation, import, export, and management
⚙️ Base Tools3 toolsConnection testing and tool discovery

🛠️ Requirements

  • Python 3.10+
  • Ignition Gateway 8.3+ with REST API enabled
  • Valid Ignition Gateway credentials or API key

📚 Documentation Structure

This repository includes comprehensive documentation:

  • - Step-by-step setup instructions
  • - Environment and settings configuration
  • - Complete API documentation for all modules
  • - Practical examples and tutorials
  • - Development guidelines and contribution process
  • - Common issues and solutions

🚀 Quick Start

1. Installation

# Clone the repository
git clone https://github.com/yourusername/ignition-mcp.git
cd ignition-mcp

# Install with uv (recommended)
uv venv
source .venv/bin/activate  # or .venv\Scripts\activate on Windows
uv pip install -e .

2. Configuration

# Copy environment template
cp .env.example .env

# Edit with your Ignition Gateway details
IGNITION_MCP_IGNITION_GATEWAY_URL=http://localhost:8088
IGNITION_MCP_IGNITION_API_KEY=your_api_key_here

3. Test & Run

# Test connection
python test_server.py

# Start MCP server
python -m ignition_mcp.main

🔗 Integration with Claude Desktop

Add to your Claude Desktop configuration:

{
  "mcpServers": {
    "ignition-mcp": {
      "command": "python",
      "args": ["-m", "ignition_mcp.main"],
      "cwd": "/path/to/ignition-mcp",
      "env": {
        "IGNITION_MCP_IGNITION_GATEWAY_URL": "http://localhost:8088",
        "IGNITION_MCP_IGNITION_API_KEY": "your_api_key"
      }
    }
  }
}

📖 Example Usage

# Test gateway connection
{"tool": "test_connection", "arguments": {}}

# Get gateway status
{"tool": "get_gateway_status", "arguments": {}}

# List all available tools
{"tool": "list_available_tools", "arguments": {}}

# Activate a license
{"tool": "put_activation_activate_key", "arguments": {"key": "YOUR-LICENSE-KEY"}}

# Create gateway backup
{"tool": "get_backup", "arguments": {"includePeerLocal": false}}

# Get recent logs
{"tool": "get_logs", "arguments": {"limit": 100, "minLevel": "INFO"}}

🤝 Contributing

We welcome contributions! Please see our for details on:

  • Development setup
  • Code style guidelines
  • Testing procedures
  • Pull request process

📄 License

This project is licensed under the MIT License - see the file for details.

🔗 Related Projects

📞 Support