OPC UA Modeler

Given one or more companion spec namespace aliases, returns the full resolved dependency list that MUST go in the YAML `namespaces:` section. Always call this before generating the namespaces block.

{
  "type": "object",
  "properties": {
    "aliases": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Companion spec aliases to resolve (e.g. [\"machineTool\", \"robotics\"])"
    }
  },
  "required": [
    "aliases"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List all well-known OPC UA companion spec namespace aliases with their full names, URIs, and dependencies. Use this to discover what namespaces are available.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List ALL ObjectTypes, VariableTypes, and InterfaceTypes defined in a specific companion spec namespace. ALWAYS call this before using any type from a namespace — NEVER guess type names.

{
  "type": "object",
  "properties": {
    "alias": {
      "type": "string",
      "description": "Companion spec alias (e.g. \"machinery\", \"di\", \"robotics\")"
    }
  },
  "required": [
    "alias"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get detailed information about a specific type: its components, properties, methods, interfaces, and optional members. Use this to understand a type's structure before creating instances or subtypes. `specRef`, on the type and on a member, is the link to the section of the specification that defines it: cite it.

{
  "type": "object",
  "properties": {
    "alias": {
      "type": "string",
      "description": "Companion spec alias where the type is defined (e.g. \"machinery\")"
    },
    "browseName": {
      "type": "string",
      "description": "The type browse name (e.g. \"MachineryItemIdentificationType\")"
    }
  },
  "required": [
    "alias",
    "browseName"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Search for types across ALL companion specs by keyword. Use this when you don't know which namespace defines a type. Returns matching types with their namespace alias.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Search keyword (e.g. \"identification\", \"temperature\", \"motion\")"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Find reusable Interfaces / AddIns by capability — pass a member name or keyword (e.g. "SerialNumber", "DeviceHealth", "Location") and get the standard blocks that already expose it. PREFER applying/composing an existing block over redefining its members inline. Interfaces are applied with `interfaces:`; addins (types with a DefaultInstanceBrowseName) are composed with `addIns:`. A single property → use the Interface; a whole named sub-object → use the AddIn.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Member name or capability keyword (e.g. \"SerialNumber\", \"health\", \"calibration\")"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Find the official UNECE Rec. 20 engineering unit symbol for a given description. ALWAYS call this before using any engineering unit — NEVER guess unit symbols.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Description or common name of the unit (e.g. \"revolutions per minute\", \"celsius\", \"pressure bar\")"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Get the grammar reference for the OPC UA modeler YAML DSL: file header, top-level sections, name-prefix conventions, minimal examples, and common mistakes. Call this FIRST before writing any YAML model by hand. Works without an API key.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Validate an OPC UA YAML model for correctness. Returns diagnostics with severity (error/warning/info), codes, messages, and line numbers. Works without an API key (limited to 50 calls/day). ALWAYS validate before generating.

{
  "type": "object",
  "properties": {
    "yaml": {
      "type": "string",
      "description": "The full YAML model source to validate"
    }
  },
  "required": [
    "yaml"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Generate OPC UA NodeSet2.xml and Symbols.CSV from a YAML model. Requires an API key (set OPCUA_MODELER_API_KEY env var). Returns base64-encoded artifacts if the model is valid, or diagnostics if validation fails. Optionally set include_docs=true to also generate markdown documentation.

{
  "type": "object",
  "properties": {
    "yaml": {
      "type": "string",
      "description": "The full YAML model source to generate from"
    },
    "include_docs": {
      "type": "boolean",
      "description": "Set to true to include markdown documentation (slower)"
    }
  },
  "required": [
    "yaml"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Reverse-engineer a NodeSet2.xml file back into the YAML DSL format. Requires an API key (set OPCUA_MODELER_API_KEY env var). Optionally specify the target namespace URI to extract.

{
  "type": "object",
  "properties": {
    "xml": {
      "type": "string",
      "description": "The NodeSet2.xml content to reverse-engineer"
    },
    "namespace_uri": {
      "type": "string",
      "description": "Target namespace URI to extract (auto-detected if omitted)"
    },
    "self_contained": {
      "type": "boolean",
      "description": "Return one self-contained .opcua.yaml stream: the model, its NodeId symbol table and dependency declarations (default: bare YAML)"
    }
  },
  "required": [
    "xml"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Generate an OPC UA YAML model from a natural language description using AI. Requires an API key (set OPCUA_MODELER_API_KEY env var). The AI will auto-detect relevant companion specs, generate a validated model with documentation, and auto-correct validation errors.

{
  "type": "object",
  "properties": {
    "prompt": {
      "type": "string",
      "description": "Natural language description of the OPC UA model to generate"
    },
    "forceSpecs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Companion spec aliases to force (e.g. [\"di\", \"ia\"])"
    }
  },
  "required": [
    "prompt"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}