Skip to main content
Glama
Sign In
Ignition-JavaDoc-MCP

Ignition-JavaDoc-MCP

by soubhagya2001
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

get_ignition_class_docs

Retrieve JavaDoc documentation for any Ignition class by specifying its package and class name. Supports multiple Ignition versions to ensure you see the correct API reference.

Instructions

Gets the documentation for a specific class.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "packagePath": "<packagePath>",
      "className": "<className>"
    },
    "name": "get_ignition_class_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
versionNoIgnition version to query (default: '8.1.39')
classNameYesThe class name (e.g., 'Dataset')
packagePathYesThe package path (e.g., 'com.inductiveautomation.ignition.common')

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries full responsibility. It states only that it 'gets documentation,' offering no detail on read-only behavior, return format, error conditions, or the effect of the version parameter. The schema's default for version is not disclosed in the description, and no safety profile is established.

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

Conciseness4/5

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

The description is a single, front-loaded sentence with no filler. It clearly conveys the operation. However, it is so terse that it sacrifices useful context; it's concise but not under-specified. It earns its place but could include more.

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

Completeness2/5

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

With no output schema and no annotations, the description leaves open what 'documentation' includes (e.g., class overview, method list). It also fails to mention the version parameter's role or how this differs from sibling doc tools. For a tool with 3 parameters and related siblings, the description is too sparse to be fully complete.

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?

Schema coverage is 100%, so each parameter (packagePath, className, version) already has a clear description. The description's phrase 'specific class' reinforces className but adds no new semantic information. Baseline 3 applies because the schema does the heavy lifting.

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

Purpose4/5

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

The description clearly states 'Gets the documentation for a specific class'—a specific verb and resource. It doesn't explicitly distinguish from sibling tools like get_ignition_package_docs or get_ignition_member_docs, but the term 'class' clarifies scope. Missing explicit sibling differentiation prevents a 5.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. There is no mention of searching the API or using package/member docs for other levels of granularity. The user must infer usage from the name alone.

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

Deploy Server

Other Tools