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

Ignition-JavaDoc-MCP

by soubhagya2001
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

get_ignition_member_docs

Retrieve complete documentation for a specific method, field, or constructor of an Ignition Java class using its member anchor ID from search results.

Instructions

Gets the full documentation for a specific member (method/field/constructor) of a class. Use the 'u' field from search_ignition_api results as memberAnchor.

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>",
      "memberAnchor": "<memberAnchor>"
    },
    "name": "get_ignition_member_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')
memberAnchorYesThe member anchor id from search results, e.g. 'getValueAt(int,java.lang.String)'

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It states the operation is to 'get' documentation, implying a safe read, and adds the context that memberAnchor comes from search results. Yet it does not describe error behavior, output format, or any potential side effects, leaving some information gaps.

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 only two sentences long, each earning its place: the first clearly states the purpose, and the second provides actionable parameter guidance. There is no redundant information or filler, making it highly efficient.

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?

For a simple documentation retrieval tool, the description covers the essential usage path: it identifies the input requirements and how to obtain the crucial memberAnchor. While it doesn't describe the output structure or error handling, the tool's complexity is low and the description provides enough context for an agent to select and invoke it correctly, especially given the sibling tool context.

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

Parameters4/5

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

Although the schema provides 100% parameter descriptions, the description adds critical semantic value for memberAnchor by explaining its origin ('u' field from search results). This goes beyond the schema's example value and clarifies how to construct a valid input. Other parameters rely on the schema, so the added meaning for one key parameter elevates the score.

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 function: retrieving full documentation for a specific member (method/field/constructor) of a class. The verb 'Gets' and the resource 'full documentation for a specific member' are specific, and the mention of member types distinguishes it from the class and package documentation siblings.

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 provides a direct usage guideline by instructing to use the 'u' field from search_ignition_api results as the memberAnchor, which is a key input. However, it does not explicitly state when to use this tool over sibling tools, relying on the member-focused wording to imply the distinction.

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