# Ignition Javadocs MCP

An MCP (Model Context Protocol) server for extremely fast and accurate searching and documentation retrieval of the Ignition Inductive Automation Java API.

## Features
- **Lightning Fast Search**: Indexes the Javadoc JSON-like artifacts (e.g. `type-search-index.js`) to provide sub-second search responses without downloading full HTML.
- **Dynamic HTML Parsing**: When detailed documentation is requested, it dynamically fetches the Javadoc HTML and meticulously converts it into clean, AI-readable Markdown using `cheerio`.
- **Multi-Version Support**: Can query any version of Ignition (default `8.1.39`) that publishes Javadoc to the inductive automation SDK domain.

## Tools Provided
- **`search_ignition_api`**: Search for `class`, `package`, or `member` by keyword.
- **`get_ignition_class_docs`**: Retrieve the full Markdown documentation for a specific class (e.g., package: `com.inductiveautomation.ignition.common`, class: `Dataset`).
- **`get_ignition_package_docs`**: Retrieve the full Markdown documentation for a specific package.
- **`get_ignition_member_docs`**: Retrieve documentation for a single member (method/field/constructor). Use the `u` field from search results as `memberAnchor`.

## Caching

The search index is cached to disk in `.cache/` (one file per Ignition version) so restarts don't re-download it. Cache entries expire after 24 hours. Override the cache location with the `IGNITION_JAVADOC_CACHE_DIR` environment variable.

## Getting Started

### Prerequisites
- Node.js >= 18

### Installation & Build
```bash
# Install dependencies
npm install

# Compile the TypeScript to JavaScript
npm run build
```

### Usage with MCP Clients
To use this with an MCP client (such as Claude Desktop), configure your MCP settings file to run this server.

Example configuration:
```json
{
  "mcpServers": {
    "ignition-javadoc": {
      "command": "node",
      "args": [
        "/path/to/Ignition-Module-Development-Docs/dist/index.js"
      ]
    }
  }
}
```

This MCP operates exclusively on `stdio`.