Ignition MCP 服务器

一个强大的 模型上下文协议（MCP） 服务器，通过其REST API与 Inductiveautomation的Ignition SCADA/MES平台 实现无缝集成。这使得AI助手能够与Ignition网关操作进行交互，以实现自动化、监控和管理任务。

🚀 特性

• 🔌 自动API集成：根据Ignition的OpenAPI规范动态生成45多种工具
• 🛡️ 灵活的身份验证：支持API密钥和基本身份验证
• 📊 实时网关管理：监控状态、管理项目、处理备份等
• 🎯 MCP协议：完全兼容Claude Desktop和其他MCP客户端
• ⚡ 异步操作：基于现代异步/等待模式，性能最优
• 🔧 完整工具集：预构建激活、备份、日志、模块和项目的工具

📋 工具分类

类别	工具	描述
🔐 激活	7个工具	许可证管理和网关激活
💾 备份	2个工具	创建和恢复网关备份
📋 日志	11个工具	日志检索、管理和分析
📦 模块	10个工具	模块健康检查和证书管理
🏗️ 项目	12个工具	项目创建、导入、导出和管理
⚙️ 基础工具	3个工具	连接测试和工具发现

🛠️ 要求

• Python 3.10+
• Ignition网关 8.3+ 并启用REST API
• 有效的Ignition网关凭据或API密钥

📚 文档结构

本仓库包括全面的文档：

• 安装指南 - 分步骤设置说明
• 配置指南 - 环境和设置配置
• API参考 - 所有模块的完整API文档
• 使用示例 - 实用示例和教程
• 贡献指南 - 开发指南和贡献流程
• 故障排除 - 常见问题及解决方案

🚀 快速开始

1. 安装

# 克隆仓库
git clone https://github.com/yourusername/ignition-mcp.git
cd ignition-mcp

# 使用uv安装（推荐）
uv venv
source .venv/bin/activate  # 或在Windows上使用 .venv\Scripts\activate
uv pip install -e .

2. 配置

# 复制环境模板
cp .env.example .env

# 编辑您的Ignition网关详情
IGNITION_MCP_IGNITION_GATEWAY_URL=http://localhost:8088
IGNITION_MCP_IGNITION_API_KEY=your_api_key_here

3. 测试与运行

# 测试连接
python test_server.py

# 启动MCP服务器
python -m ignition_mcp.main

🔗 与Claude Desktop集成

添加到您的Claude Desktop配置中：

{
  "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"
      }
    }
  }
}

📖 示例用法

# 测试网关连接
{"tool": "test_connection", "arguments": {}}

# 获取网关状态
{"tool": "get_gateway_status", "arguments": {}}

# 列出所有可用工具
{"tool": "list_available_tools", "arguments": {}}

# 激活许可证
{"tool": "put_activation_activate_key", "arguments": {"key": "YOUR-LICENSE-KEY"}}

# 创建网关备份
{"tool": "get_backup", "arguments": {"includePeerLocal": false}}

# 获取最近的日志
{"tool": "get_logs", "arguments": {"limit": 100, "minLevel": "INFO"}}

🤝 贡献

我们欢迎贡献！请参阅我们的 贡献指南，了解以下内容：

• 开发设置
• 代码风格指南
• 测试程序
• 拉取请求流程

📄 许可证

本项目采用MIT许可证 - 查看LICENSE文件获取详细信息。

🔗 相关项目

• 模型上下文协议 - MCP规范
• Ignition文档 - 官方Ignition文档
• Claude Desktop - 支持MCP的AI助手

📞 支持

• 问题：GitHub问题
• 讨论：GitHub讨论
• 文档：项目维基