开源MCP工具

Required reverse proxy responsibilities for strict i3X compliance

See the NGINX configuration reference and HTTPS guide for details.

Docker

Quickstart (Docker image):

docker run -d --name i3x2ua-master -p 8080:8000 -e I3X_ENABLE_MCP=1 -e I3X_OPCUA_ENDPOINT=opc.tcp://opcua.umati.app:4843 ghcr.io/andreasheine/i3x2ua:master

Multiline (bash):

docker run -d \
	--name i3x2ua-master \
	-p 8080:8000 \
	-e I3X_ENABLE_MCP=1 \
	-e I3X_OPCUA_ENDPOINT=opc.tcp://opcua.umati.app:4843 \
	ghcr.io/andreasheine/i3x2ua:master

Run with compose:

docker compose up -d

Build your own image with an explicit server version for /v1/info:

docker build --build-arg BUILD_VERSION=1.1.0 -t i3x2ua:1.1.0 .

If BUILD_VERSION is not set, the API falls back to master.

The stack now starts the API behind an nginx reverse proxy. The app container stays internal, while nginx exposes HTTP and optional HTTPS.

The default compose setup also enables container hardening (read_only, tmpfs, dropped Linux capabilities, no-new-privileges).

Optional environment variables:

• I3X_ENABLE_MCP=1 to enable MCP support; it is disabled by default
• I3X_OPCUA_CERTS_DIR=./certs to mount OPC UA client/server certificate files into the app container (/app/certs)
• NGINX_HTTPS_ENABLED=1 to enable TLS termination
• NGINX_SSL_CERTS_DIR=./certs with fullchain.pem and privkey.pem
• NGINX_BASIC_AUTH_ENABLED=1 with NGINX_BASIC_AUTH_USER and NGINX_BASIC_AUTH_PASSWORD
• NGINX_SERVER_NAME for the public host name

If you enable HTTPS, mount or place the certificate files in the configured cert directory before starting Compose.

If your OPC UA server runs on the Docker host machine, set I3X_OPCUA_ENDPOINT to opc.tcp://host.docker.internal:<port> instead of 127.0.0.1.

For local HTTPS testing with the nginx reverse proxy, generate sample certificates:

uv run python scripts/generate_https_dev_cert.py

Then use these environment values:

• NGINX_HTTPS_ENABLED=1
• NGINX_SSL_CERTS_DIR=./certs
• NGINX_SSL_CERTIFICATE=/etc/nginx/certs/https-sample/fullchain.pem
• NGINX_SSL_CERTIFICATE_KEY=/etc/nginx/certs/https-sample/privkey.pem

Production Deployment and i3X Strict Compliance

This application implements the i3X API specification and is designed to run behind a reverse proxy that is responsible for:

• TLS termination — the app itself serves plain HTTP; all HTTPS is handled by nginx.
• Authentication and authorization — the app has no built-in auth layer; token validation, basic auth, or mTLS are enforced at the proxy level.

Quick Start

Requirements:

• Python 3.10 to 3.12
• uv
• Optional: running OPC UA server

Install dependencies:

uv sync --extra dev

Start API:

uv run uvicorn i3x_server.main:app --reload --host 127.0.0.1 --port 8000

Start without OPC UA server (PowerShell):

$env:I3X_SKIP_OPCUA_CONNECT="1"
uv run uvicorn i3x_server.main:app --reload --host 127.0.0.1 --port 8000

Enable MCP support explicitly when you want the /mcp endpoints and MCP tool catalog to be available:

$env:I3X_ENABLE_MCP="1"
uv run uvicorn i3x_server.main:app --reload --host 127.0.0.1 --port 8000

If you do not set I3X_ENABLE_MCP, the app starts without MCP support and /mcp returns 404.

Use encrypted OPC UA with the included sample client certificate (development/testing):

uv run python scripts/generate_opcua_client_cert.py

$env:I3X_OPCUA_SECURITY_MODE="SignAndEncrypt"
$env:I3X_OPCUA_SECURITY_POLICY="Basic256Sha256"
$env:I3X_OPCUA_CLIENT_CERT_PATH="./certs/opcua-client-sample/client-cert.pem"
$env:I3X_OPCUA_CLIENT_KEY_PATH="./certs/opcua-client-sample/client-key.pem"
uv run uvicorn i3x_server.main:app --reload --host 127.0.0.1 --port 8000

The OPC UA server may require manually trusting the sample client certificate before the secure session can be established.

If you create your own OPC UA client certificates, ensure they include OPC UA-compatible SAN and key usage fields (application URI, DNS names, clientAuth EKU, and signing/encipherment key usages) and match the server's exposed security mode/policy.

OpenAPI/Swagger:

• http://127.0.0.1:8000/openapi.json
• http://127.0.0.1:8000/docs

The i3X API Gateway for OPC UA — REST, MCP & Real-Time Streaming

FastAPI gateway implementing the i3X API over OPC UA — exposes OPC UA address spaces as standardized REST and MCP endpoints with JSON responses, OpenAPI docs, and Server-Sent Event subscriptions. Built for teams that do not have deep OPC UA expertise.

API Surface

Active endpoints are exposed under /v1 for:

• info and metadata (/info, /namespaces, /objecttypes, /relationshiptypes)
• filtered type queries (/objecttypes/query, /relationshiptypes/query)
• object queries and values (/objects, /objects/list, /objects/related, /objects/value, /objects/history)
• subscriptions (/subscriptions, /subscriptions/register, /subscriptions/unregister, /subscriptions/sync, /subscriptions/list, /subscriptions/delete, /subscriptions/stream)

Current scope emphasis: this implementation currently prioritizes read/query/subscribe operations.

Optional MCP endpoints are exposed only when I3X_ENABLE_MCP=1:

• discovery and tool catalog (/mcp, /mcp/tools)
• JSON-RPC and tool call entry points (/mcp, /mcp/call)

MCP scope emphasis: the MCP bridge is currently focused on tool calling (initialize, tools/list, tools/call) for the current implementation scope.

maxDepth Semantics (Hierarchy vs Composition)

Value/history recursion follows only the composition plane (HasComponent / ComponentOf). Hierarchy edges (HasChildren / HasParent) are used for structure/navigation and root selection, not for value recursion.

Example:

• Hierarchy: Plant -> Line -> Pump
• Composition: Pump -> Temperature, Pump -> Pressure

POST /objects/value for Plant with maxDepth = 0 does not include Pump values via hierarchy. POST /objects/value for Pump with maxDepth = 0 includes Temperature and Pressure as components.

POST /objects/related returns relationships across all three planes (hierarchy, composition, and graph) for each requested element.