node-opcua-modeler-mcp-server 1.3.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -21
- package/NOTICE +21 -0
- package/README.md +68 -6
- package/catalog/catalog.json +6706 -1432
- package/dist/catalog.d.ts +6 -0
- package/dist/catalog.js +6 -0
- package/dist/catalog.js.map +1 -1
- package/dist/cloud.d.ts +21 -6
- package/dist/cloud.js +173 -49
- package/dist/cloud.js.map +1 -1
- package/dist/local.d.ts +74 -0
- package/dist/local.js +149 -0
- package/dist/local.js.map +1 -0
- package/dist/server.d.ts +13 -17
- package/dist/server.js +185 -166
- package/dist/server.js.map +1 -1
- package/package.json +5 -3
- package/server.json +2 -2
package/LICENSE
CHANGED
|
@@ -1,21 +1,202 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
OPC UA Modeler MCP Server
|
|
2
|
+
Copyright 2025-2026 Sterfive SAS
|
|
3
|
+
|
|
4
|
+
This product includes software developed by Sterfive SAS
|
|
5
|
+
(https://www.sterfive.com).
|
|
6
|
+
|
|
7
|
+
"OPC UA Modeler", "Sterfive" and the Sterfive logo are trademarks of
|
|
8
|
+
Sterfive SAS. The Apache License, Version 2.0 under which this software is
|
|
9
|
+
distributed grants no rights to use these trademarks (see Section 6 of the
|
|
10
|
+
licence). Forks and derivative works must not present themselves as the
|
|
11
|
+
official OPC UA Modeler MCP Server or as endorsed by Sterfive.
|
|
12
|
+
|
|
13
|
+
"OPC UA" is a trademark of the OPC Foundation. The catalog shipped with this
|
|
14
|
+
package is derived from companion-specification NodeSet2.xml files published
|
|
15
|
+
by the OPC Foundation and its joint working groups; the underlying
|
|
16
|
+
specifications remain the property of their respective owners.
|
|
17
|
+
|
|
18
|
+
The hosted OPC UA Modeler API (opcua-modeler.sterfive.io) that this client
|
|
19
|
+
talks to is a separate service governed by the Sterfive API Terms of Use, and
|
|
20
|
+
the OPC UA Modeler CLI / `opcua-modeler serve` are separate products governed
|
|
21
|
+
by the Sterfive commercial licence. Neither is covered by this licence.
|
package/README.md
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
# node-opcua-modeler-mcp-server
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/node-opcua-modeler-mcp-server)
|
|
4
|
-
[](https://www.npmjs.com/package/node-opcua-modeler-mcp-server)
|
|
5
|
+
[](https://www.npmjs.com/package/node-opcua-modeler-mcp-server)
|
|
6
|
+
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
5
7
|
[](https://modelcontextprotocol.io)
|
|
6
8
|
|
|
7
9
|
An [MCP server](https://modelcontextprotocol.io) that gives AI agents access to the **OPC UA companion specification type system** — 589 types across 22 industrial namespaces, plus 1,533 engineering units — and lets agents **validate, generate, reverse-engineer, and create** OPC UA information models.
|
|
@@ -48,6 +50,51 @@ npx node-opcua-modeler-mcp-server
|
|
|
48
50
|
|
|
49
51
|
The server communicates over **stdio** using the [Model Context Protocol](https://modelcontextprotocol.io).
|
|
50
52
|
|
|
53
|
+
### Using a local backend instead of the hosted API
|
|
54
|
+
|
|
55
|
+
If you run the OPC UA Modeler CLI on the same machine, the model tools can be
|
|
56
|
+
served from it instead of the hosted API — your YAML never leaves the host.
|
|
57
|
+
|
|
58
|
+
Start the server (requires a licence that includes the `serve` entitlement):
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
opcua-modeler serve
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Then set one environment variable in your MCP client config:
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"mcpServers": {
|
|
69
|
+
"opcua-modeler": {
|
|
70
|
+
"command": "npx",
|
|
71
|
+
"args": ["-y", "node-opcua-modeler-mcp-server"],
|
|
72
|
+
"env": {
|
|
73
|
+
"OPCUA_MODELER_BACKEND": "local"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
No API key is needed in this mode — the client discovers the local endpoint and
|
|
81
|
+
its credentials automatically.
|
|
82
|
+
|
|
83
|
+
| Variable | Values | Purpose |
|
|
84
|
+
|----------|--------|---------|
|
|
85
|
+
| `OPCUA_MODELER_BACKEND` | `cloud` (default), `local` | Which backend serves the model tools |
|
|
86
|
+
| `OPCUA_MODELER_API_KEY` | `stfv_…` | API key, `cloud` backend only |
|
|
87
|
+
| `OPCUA_MODELER_API_URL` | URL | Override the hosted API base URL |
|
|
88
|
+
|
|
89
|
+
**Notes**
|
|
90
|
+
|
|
91
|
+
- The two backends are never mixed, and there is no fallback between them. If
|
|
92
|
+
`local` is selected and no server is running, the call fails with instructions
|
|
93
|
+
rather than silently sending your model to the hosted API.
|
|
94
|
+
- The seven discovery tools are local to this package and work offline on either
|
|
95
|
+
setting.
|
|
96
|
+
- `opcua_model_create` (AI generation) is available on the `cloud` backend only.
|
|
97
|
+
|
|
51
98
|
## Tools
|
|
52
99
|
|
|
53
100
|
### `list_namespaces`
|
|
@@ -131,7 +178,7 @@ Find the official UNECE Rec. 20 engineering unit symbol. Supports fuzzy matching
|
|
|
131
178
|
← { "symbol": "°C", "matchType": "alias", "confidence": 1 }
|
|
132
179
|
|
|
133
180
|
→ find_engineering_unit({ query: "revolutions per minute" })
|
|
134
|
-
← { "symbol": "
|
|
181
|
+
← { "symbol": "r/min", "matchType": "alias", "confidence": 1 }
|
|
135
182
|
|
|
136
183
|
→ find_engineering_unit({ query: "bar" })
|
|
137
184
|
← { "symbol": "bar", "matchType": "exact", "confidence": 1 }
|
|
@@ -233,7 +280,7 @@ Generate an OPC UA YAML model from a natural language description using AI. The
|
|
|
233
280
|
|
|
234
281
|
### Engineering Units
|
|
235
282
|
|
|
236
|
-
1,533 official UNECE Rec. 20 symbols plus 134 natural language aliases (e.g., "celsius" → °C, "revolutions per minute" →
|
|
283
|
+
1,533 official UNECE Rec. 20 symbols plus 134 natural language aliases (e.g., "celsius" → °C, "revolutions per minute" → r/min). Every alias resolves to a symbol the modeler engine accepts — the lookup never invents one.
|
|
237
284
|
|
|
238
285
|
## How It Works
|
|
239
286
|
|
|
@@ -272,10 +319,25 @@ The server ships with a pre-generated `catalog.json` containing all type informa
|
|
|
272
319
|
|
|
273
320
|
## Related
|
|
274
321
|
|
|
322
|
+
- [OPC UA Modeler — web app](https://opcua-modeler.sterfive.io) — Create, validate, and generate OPC UA information models in the browser
|
|
323
|
+
- [Product page](https://www.sterfive.com/product/opcua-modeler) — OPC UA Modeler overview, features, and licensing
|
|
324
|
+
- [Documentation](https://opcua-modeler.doc.sterfive.com) — Guides, YAML DSL reference, and how-tos
|
|
325
|
+
- [Specification reference](https://opcua-modeler.doc.sterfive.com/specification/spec.html) — Rendered OPC UA information-model specification
|
|
275
326
|
- [node-opcua](https://github.com/node-opcua/node-opcua) — Full OPC UA stack for Node.js
|
|
276
|
-
- [OPC UA Modeler](https://opcua-modeler.sterfive.io) — Create, validate, and generate OPC UA information models
|
|
277
327
|
- [Model Context Protocol](https://modelcontextprotocol.io) — Open protocol for AI tool integration
|
|
278
328
|
|
|
279
|
-
##
|
|
329
|
+
## Licensing
|
|
330
|
+
|
|
331
|
+
Three layers, stated once:
|
|
332
|
+
|
|
333
|
+
| What | Licence |
|
|
334
|
+
|------|---------|
|
|
335
|
+
| **This package** (`node-opcua-modeler-mcp-server`, the MCP client and its catalog) | [Apache License 2.0](./LICENSE) from version 1.5.0 — see [NOTICE](./NOTICE) for trademark and third-party notices. Versions 1.0–1.4.x were published under MIT and remain so. |
|
|
336
|
+
| **The hosted OPC UA Modeler API** (`opcua-modeler.sterfive.io/api/v1`) that the cloud backend calls | [Sterfive API Terms of Use](https://opcua-modeler.sterfive.io/terms) — anonymous discovery, free and paid plans. |
|
|
337
|
+
| **The OPC UA Modeler CLI and `opcua-modeler serve`** (the local backend) | Sterfive commercial licence — see the [product page](https://www.sterfive.com/product/opcua-modeler). |
|
|
338
|
+
|
|
339
|
+
"OPC UA Modeler" and "Sterfive" are trademarks of Sterfive SAS; the Apache
|
|
340
|
+
licence grants no rights to them. Contributions are accepted under the
|
|
341
|
+
[Developer Certificate of Origin](./CONTRIBUTING.md).
|
|
280
342
|
|
|
281
|
-
|
|
343
|
+
© [Sterfive SAS](https://www.sterfive.com)
|