Skip to main content
Glama
Sign In
Ignition Doc MCP

Ignition Doc MCP

by nurnaufal321
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

Ignition Doc MCP

Ground your AI answers in live Inductive Automation Ignition documentation.

Python 3.11+ MCP License: MIT

What it does

Ignition Doc MCP is a Model Context Protocol (MCP) server that gives AI assistants like Claude direct access to the official Inductive Automation Ignition documentation. Instead of relying on training data that may be outdated or incorrect, the AI fetches real answers from live docs — eliminating hallucination on Ignition-specific topics.

Covers both the Ignition User Manual (always the latest version) and the Ignition SDK Programmer's Guide.

Related MCP server: Whoosh RAG MCP

How it works

The server queries the Typesense search backends that power docs.inductiveautomation.com and sdk-docs.inductiveautomation.com in real time. No API key required, no local doc files, no indexing step — every search goes directly to Inductive Automation's search backend and returns content that is always up to date.

The User Manual search is pinned to the docs-default-current tag, which automatically resolves to the latest published version — no manual version bumps needed when Ignition releases a new version.

Prerequisites

Installation

1. Clone the repository

git clone https://github.com/nurnaufal321/inductiveautomation-doc-mcp.git
cd inductiveautomation-doc-mcp

2. Install dependencies

uv sync

3. Register with Claude Code

claude mcp add ignition-docs --scope user -- uv run --directory /path/to/inductiveautomation-doc-mcp python server.py

Replace /path/to/inductiveautomation-doc-mcp with the absolute path to the cloned folder.

4. Restart Claude Code to pick up the new MCP server. You should see ignition-docs listed when you run:

claude mcp list

Available Tools

Once registered, Claude has access to three tools:

Tool

Description

search_ignition_docs

Search the Ignition User Manual (latest version) by keyword. Optional: n_results (default 5, max 20).

search_ignition_sdk

Search the Ignition SDK Programmer's Guide by keyword. Optional: n_results (default 5, max 20).

get_page

Fetch the full text of a documentation page by URL. Optional: max_chars (default 4000, max 12000).

Usage Examples

Ask Claude questions like:

  • "How do I configure an OPC-UA connection in Ignition?"

  • "What Vision window types are available?"

  • "How does tag history deadband work?"

  • "How do I create a GatewayModuleHook for my Ignition module?"

  • "What are the core modules included in Ignition?"

Claude will search the live docs and cite the exact page it used.

Scope

Ignition User Manual

Covers the full Ignition platform including:

  • Tags, Tag Historian, and Tag Diagnostics

  • Perspective and Vision modules

  • Scripting and Python in Ignition

  • Alarm Notification and Event Streams

  • OPC-UA, SQL Bridge, Reporting

  • Gateway, Designer, and Client configuration

  • Transaction Groups and Database connections

Ignition SDK Programmer's Guide

Covers module development including:

  • GatewayModuleHook, DesignerModuleHook, ClientModuleHook

  • Tag providers, drivers, and OPC server development

  • Gateway network communication

  • Component and style development

References

Disclaimer

This project is not affiliated with, endorsed by, or supported by Inductive Automation. It queries Inductive Automation's publicly accessible documentation search backend for personal and developer use. Users are responsible for complying with Inductive Automation's terms of use.

License

This project is licensed under the MIT License. See LICENSE for details.

Available Tools

3 tools
get_pageA

Fetch the text content of an Ignition documentation page by URL.

Use URLs returned by search_ignition_docs or search_ignition_sdk.

Inputs: url (required), max_chars. Returns: result

search_ignition_docsA

Search the Ignition User Manual (always the latest version).

Use this for questions about Ignition configuration, tags, scripting, modules, gateways, designers, and general product usage.

Inputs: query (required), n_results. Returns: result

search_ignition_sdkA

Search the Ignition SDK Programmer's Guide.

Use this for questions about building Ignition modules: GatewayModuleHook, DesignerModuleHook, ClientModuleHook, AbstractGatewayModuleHook, and the Ignition module API.

Inputs: query (required), n_results. Returns: result

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Deploy Server
    One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

    TDQS

    A4/5.0

    Scored across 3 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose: two search tools target different documentation sets (user manual vs SDK guide), and get_page fetches content by URL. No overlap or ambiguity exists.

    Naming Consistency5/5

    The search tools follow a consistent 'search_ignition_' prefix pattern, and get_page is a simple, clear verb_noun pair. All names are snake_case and readable.

    Tool Count4/5

    With 3 tools, the set is minimal but well-scoped for a documentation-focused server. It covers the primary needs without unnecessary bloat, though it could benefit from one or two more tools.

    Completeness4/5

    The tool surface covers core documentation workflows: searching two main documentation sources and fetching specific pages. Minor gaps like version selection or browsing are absent, but for typical usage it is sufficient.

    Resources

    Related MCP Connectors

    Related MCP Servers