Skip to main content
Glama
nurnaufal321

Ignition Doc MCP

by nurnaufal321

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
urlYes
max_charsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It discloses the constraint that URLs should come from search tools (a behavioral trait), but it does not mention potential side effects, authentication needs, or behavior around the max_chars parameter. It is safe to assume a fetch is read-only, but the description does not explicitly confirm it.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences long, with the core action upfront and the usage context in the second sentence. Every word earns its place, and it is highly efficient without any fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a simple fetch tool with an output schema, and the description gives enough context for the main use case (feed it a URL from search). The missing information about 'max_chars' and error behavior is a minor gap, but the tool's simplicity keeps the description largely adequate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It adds meaning to the 'url' parameter by specifying it comes from search tools, but it completely omits any explanation of 'max_chars', leaving that parameter undocumented. The description only partially compensates for the low coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Fetch the text content') and the resource ('an Ignition documentation page'). It also distinguishes itself from sibling search tools by specifying that it retrieves content for a given URL, making the purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly instructs to use URLs returned by the sibling search tools, providing clear workflow guidance on when to use this tool relative to alternatives. This is a direct 'when to use' pointer that prevents misuse.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryYes
n_resultsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of disclosure. It adds the useful behavioral detail that it always searches the latest version, but it does not mention any limitations, side effects, or safety profile (e.g., read-only nature). For a search tool, this is a moderate disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with the key action and resource front-loaded. Every sentence contributes: the first states the core function, the second provides use-case guidance. No wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description is reasonably complete for a simple search tool: it covers purpose, topics, and version. However, it lacks parameter explanations and does not reference sibling tools for alternative use cases. The presence of an output schema mitigates the need for return value details, but the missing parameter semantics is a clear gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It only implies that 'query' is a natural language question (via 'questions about...'), but 'n_results' is entirely unexplained. Neither parameter gets meaningful semantic elaboration.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Search') and the resource ('the Ignition User Manual'), and specifies that it always uses the latest version. It also enumerates covered topics (configuration, tags, scripting, modules, gateways, designers), which distinguishes it from sibling tools like search_ignition_sdk.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says 'Use this for questions about...' and lists relevant topics, providing clear usage context. However, it does not explicitly mention when not to use it or point to alternatives (e.g., search_ignition_sdk), so it falls short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

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.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryYes
n_resultsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description bears responsibility for disclosing behavior. The description indicates the search source (SDK Programmer's Guide) and the intended query context, but does not explicitly state that this is a read-only operation, what it returns, or any pagination/format details. Since 'search' implies a non-destructive operation, the risk is low, but the description lacks richer behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, front-loaded with the primary action, and every word adds value. It avoids redundancy and clearly communicates purpose and usage in minimal text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description provides sufficient context for a simple search tool: it names the search source and the type of queries. The presence of an output schema reduces the need to explain return values. However, the unclarified 'n_results' parameter leaves a small gap in completeness, preventing a perfect score.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage; the schema only defines 'query' and 'n_results' with no per-parameter descriptions. The description partially compensates by suggesting 'query' should be about building Ignition modules, but it does not explain 'n_results' at all. Since the description adds some semantic value for 'query' but leaves 'n_results' undefined, a score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Search the Ignition SDK Programmer's Guide.' It specifies the resource (SDK Programmer's Guide) and the intended use case (questions about building Ignition modules), listing concrete classes like GatewayModuleHook and DesignerModuleHook. This distinguishes it from sibling tools like search_ignition_docs, which likely covers broader documentation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says 'Use this for questions about building Ignition modules,' providing clear context for when to invoke this tool. While it does not name alternatives or exclusion criteria, the specific use case and the mention of the SDK guide imply a narrower scope than general docs search. This is clear context without explicit alternatives, matching a score of 4.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

TDQS

A4/5.0
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.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nurnaufal321/inductiveautomation-doc-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server