node-opcua-modeler-mcp-server 1.3.0 → 1.4.2
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/README.md +53 -3
- 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 +1 -1
- package/server.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
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)
|
|
4
6
|
[](https://opensource.org/licenses/MIT)
|
|
5
7
|
[](https://modelcontextprotocol.io)
|
|
6
8
|
|
|
@@ -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,8 +319,11 @@ 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
|
## License
|