Documentation

Guides, references, and everything you need to build manufacturing AI agents with OpenShopFloor.

Getting Started

OpenShopFloor exposes a full manufacturing simulation through 118 MCP (Model Context Protocol) tools. Your AI agent connects to our MCP server and gets access to real-time factory data.

// Connect your agent to the MCP server
endpoint: "https://api.openshopfloor.zeroguess.ai/mcp"
auth: "Bearer YOUR_API_KEY"

The factory simulates a complete manufacturing environment: CNC machines, injection molding (SGM), assembly lines, pre-assembly, and a test field. All connected to ERP, OEE, QMS, tool management databases, Historian (time-series analytics), and Knowledge Graph (graph queries & semantic search).

v9 adds schema-driven Knowledge Graph building, vector embeddings for semantic search, natural language chart generation, and industrial time-series analytics via the Historian service.

Tool Reference

Capacity Planning

6 tools

Machine utilization, load analysis, CM01/CM21

factory_get_cm01

Capacity utilization (CM01) for a machine by period (day/week).

ParameterRequired
machineNoyes
periodTypeno
periodCountno
factory_get_capacity_overview

Capacity overview of all machines. Identifies over-/under-utilized machines.

ParameterRequired
periodTypeno
periodCountno
factory_get_capacity_summary

Compact capacity summary of all machines (current + next week).

factory_get_cm21_orders

Production orders per work center (CM21), filterable by machine.

ParameterRequired
machineNono
factory_get_shift_schedule

Shift model for all departments: which shifts run when, net minutes, holidays.

ParameterRequired
machineIdno
factory_get_capacity_load

Average capacity utilization in percent.

Customer Orders

4 tools

Order tracking, delivery risk, VA05

factory_get_customer_orders

Lists all customer orders: customer, article, quantity, delivery dates, status.

ParameterRequired
statusno
factory_get_customer_order

Details of a customer order including production order and delivery status.

ParameterRequired
kundenauftragNryes
factory_get_va05_summary

VA05 overview: total count, open, in production, shipped, overdue.

factory_get_orders_at_risk

At-risk customer orders near delivery date or overdue.

ParameterRequired
daysAheadno

KPIs & Revenue

3 tools

OTD, revenue, delivery performance

factory_get_customer_otd

Overall on-time delivery rate across all customers.

factory_get_otd_statistics

Detailed OTD statistics overall and per customer.

factory_get_monthly_revenue

Monthly revenue from delivered customer orders.

Maintenance

5 tools

Notifications, MTBF/MTTR, downtime analysis

factory_get_open_notifications

All open fault and maintenance notifications.

factory_get_maintenance_orders

Maintenance orders, optionally filtered by status.

ParameterRequired
statusno
factory_get_machine_reliability

Reliability metrics: MTBF, MTTR, availability.

ParameterRequired
machineNoyes
daysBackno
factory_get_maintenance_summary

PM overview: open notifications, orders, MTBF/MTTR.

factory_get_downtime_report

Downtime analysis with reason codes and duration.

ParameterRequired
daysBackno

Material Planning

4 tools

MD04, MD07, availability forecasts, shortages

factory_get_md04

Requirements/stock list (MD04) for a part, similar to SAP MD04.

ParameterRequired
teilIdyes
factory_get_md07

All current shortages (MD07) — parts with stock deficits.

factory_get_availability_at_date

Forecasts part availability at a specific date.

ParameterRequired
teilIdyes
dateyes
factory_get_baugruppen_shortages

Shortages for assemblies (in-house production, not purchasable).

OEE & Production

5 tools

Availability, performance, quality, scrap history

factory_get_machine_oee

OEE of a machine: availability x performance x quality.

ParameterRequired
machineNoyes
hoursno
factory_get_latest_oee

Latest OEE values for all machines.

factory_get_production_history

Production history: good parts, scrap, rework per hour.

ParameterRequired
hoursno
factory_get_oee_summary

OEE summary per machine: avg, min, max, scrap rate over a period. Sorted worst first.

ParameterRequired
hoursno
factory_get_scrap_history

Scrap history grouped by machine.

ParameterRequired
hoursno

Work Orders

4 tools

Order details, machine queues, material readiness

factory_get_work_order

Details of a work order including material and capacity status.

ParameterRequired
orderNoyes
factory_get_machine_queue

Machine queue: orders sorted by priority.

ParameterRequired
machineNoyes
factory_check_material_readiness

Check material availability for a work order.

ParameterRequired
orderNoyes
factory_get_blocked_orders_count

Number of blocked orders (material/capacity).

Purchasing

3 tools

Open purchases, suppliers, evaluations

factory_get_pending_purchases

All open purchase orders with expected delivery dates.

factory_get_supplier_for_material

Supplier for a material with lead time and price.

ParameterRequired
teilIdyes
factory_get_supplier_evaluation

Supplier evaluation: delivery reliability, quality, pricing.

ParameterRequired
supplierIdno

Quality Management

4 tools

SPC alarms, calibration, Cpk, quality notifications

factory_get_spc_alarms

Active SPC alarms with affected machines.

factory_get_calibration_due

Measuring instruments with calibration due.

factory_get_quality_notifications

Open quality notifications (complaints, internal defects).

factory_get_cpk_overview

Process capability indices (Cpk) for all monitored characteristics.

ParameterRequired
machineNono

Stock & Inventory

3 tools

Stock levels, reservations, low-stock alerts

factory_get_stock_item

Stock level of a material with reservations and availability.

ParameterRequired
teilIdyes
factory_get_low_stock_items

Materials with low stock (below safety stock level).

factory_get_material_coverage

Material coverage in days — which materials have the lowest reach based on stock vs. open demand.

Tool Management

9 tools

Tool wear, replacements, article tool lists

tms_get_status

Status of all tools: wear, location, availability.

tms_get_machine_tools

All tools currently at a machine.

ParameterRequired
machine_noyes
tms_get_critical

Tools with critical wear (>80%).

tms_replace_tool

Replace a worn tool at a machine.

ParameterRequired
machine_noyes
old_tool_idyes
new_tool_idno
tms_get_replacements

Available replacement tools for a tool type.

ParameterRequired
werkzeug_idyes
tms_get_tools_for_article

Tool list for an article — required tool types.

ParameterRequired
article_noyes
tms_check_tool_availability

Checks if a machine has all required tools for an article.

ParameterRequired
machine_noyes
article_noyes
tms_get_tool_changes

Required tool changes for a changeover + additional setup time.

ParameterRequired
machine_noyes
article_noyes
tms_get_history

Recent tool usages and replacements.

ParameterRequired
limitno

Injection Molding

5 tools

Process data, cavity balance, trends, aggregates

sgm_get_process_data

Injection molding process data (~97 parameters): temperatures, pressures, speeds.

ParameterRequired
machine_noyes
hoursno
sgm_get_process_trend

Trend of a process parameter over time — drift detection.

ParameterRequired
machine_noyes
parameteryes
hoursno
sgm_get_cavity_balance

Cavity balance (pressure distribution) — detects uneven filling.

ParameterRequired
machine_noyes
shotsno
sgm_get_cavity_trend

Trend of a cavity (hot runner temp, pressure) over time.

ParameterRequired
machine_noyes
cavity_nryes
hoursno
sgm_get_hourly_aggregates

Hourly aggregates: averages, shot count, scrap rate.

ParameterRequired
machine_noyes
hoursno

Assembly Lines

14 tools

Station tools, OEE, BDE, process data, maintenance

montage_get_tms_status

Status of all assembly tools: wear, station, availability.

montage_get_critical_tools

Assembly tools with critical wear (>80%).

montage_get_station_tools

All tools at an assembly station.

ParameterRequired
station_idyes
montage_get_replacements

Replacement tools for an assembly tool type.

ParameterRequired
werkzeug_idyes
montage_replace_tool

Replace a worn tool at an assembly station.

ParameterRequired
station_idyes
old_tool_idyes
montage_get_tool_history

Recent tool usages at assembly stations.

ParameterRequired
limitno
montage_get_maintenance_summary

Assembly line maintenance overview.

montage_get_open_notifications

Open fault/maintenance notifications for assembly lines.

montage_get_open_orders

Open maintenance orders for assembly lines.

montage_get_station_reliability

Reliability metrics: MTBF, MTTR, availability.

ParameterRequired
station_idno
montage_get_due_plans

Due maintenance plans for assembly lines.

montage_get_oee

OEE of an assembly line (availability, performance, quality).

ParameterRequired
linie_idno
montage_get_prozessdaten

Process data of an assembly station (parameters, targets, tolerances).

ParameterRequired
station_idyes
limitno
montage_get_bde

Shop floor data: cycle times, good parts, NOK parts, fault reasons.

ParameterRequired
linie_idno
limitno

Energy Management

6 tools

Consumption, cost, per-part energy, base load

factory_get_energy_overview

Energy consumption of all machines: current power draw, total kWh.

factory_get_machine_energy

Energy consumption of a machine over time.

ParameterRequired
machineNoyes
hoursno
factory_get_energy_per_part

kWh per good part for a machine.

ParameterRequired
machineNoyes
hoursno
factory_get_energy_costs

Energy costs in EUR.

ParameterRequired
pricePerKwhno
hoursno
factory_get_energy_trend

Hourly power trend for a machine.

ParameterRequired
machineNoyes
hoursno
factory_get_base_load

Base load vs. production load of all machines.

Subcontracting

7 tools

External processing orders, supplier capacity

factory_get_fb_auftraege

All subcontracting orders with status.

ParameterRequired
statusno
factory_get_fb_kapazitaet

Capacity and utilization of subcontracting suppliers.

factory_get_fb_versand

Orders ready for shipment to supplier.

factory_get_fb_wareneingang

Orders with expected goods receipt.

factory_get_fb_liefertreue

Delivery reliability of subcontracting suppliers.

factory_get_fb_queue

Orders in queue by supplier.

ParameterRequired
lieferantIdno
factory_get_fb_bewertung

Quality rating of subcontracting suppliers.

Pre-Assembly

4 tools

Cell status, OEE, buffer levels, maintenance

montage_get_vormontage_status

Status of pre-assembly cells VM-1, VM-2, VM-3.

montage_get_vormontage_oee

OEE of pre-assembly cells.

ParameterRequired
cell_idno
montage_get_vormontage_buffer

Buffer fill levels between pre-assembly and assembly lines.

montage_get_vormontage_wartung

Maintenance status of pre-assembly stations.

Test Field

4 tools

Function tests, leak tests, burn-in, defect analysis

montage_get_prueffeld_status

Status of the test field (function test, leak test, burn-in).

montage_get_prueffeld_ergebnisse

Pass/fail rate of the test field.

ParameterRequired
hoursno
montage_get_prueffeld_queue

Parts in the test field queue.

montage_get_prueffeld_fehleranalyse

Defect analysis by defect type and product.

History

6 tools

Time-series trends, comparisons, aggregations, anomaly detection

history_get_trend

Time-series data for a machine variable over configurable hours.

ParameterRequired
machineyes
variableyes
hoursno
limitno
history_compare

Compare same variable between two machines.

ParameterRequired
machine_ayes
machine_byes
variableyes
hoursno
history_aggregate

Aggregated values (AVG/MIN/MAX) per granularity.

ParameterRequired
machineyes
variableyes
granularityno
hoursno
history_anomalies

Find values deviating beyond N sigma from mean.

ParameterRequired
machineyes
variableyes
hoursno
sigmano
history_machines

List all machines with historian data and data point counts.

ParameterRequired
hoursno
history_variables

List all recorded variables for a specific machine.

ParameterRequired
machineyes

Knowledge Graph

12 tools

Impact analysis, paths, neighbors, semantic search, schema, Cypher queries, chart generation, delivery snapshots

kg_impact

Trace downstream impact from a source node (up to 3 hops).

ParameterRequired
node_idyes
kg_path

Find shortest path between two nodes.

ParameterRequired
from_idyes
to_idyes
kg_neighbors

Get all neighbor nodes within configurable depth.

ParameterRequired
node_idyes
depthno
kg_aggregate

Aggregate numeric property across a label.

ParameterRequired
labelyes
propertyyes
kg_search

Semantic search by natural language using vector embeddings.

ParameterRequired
queryyes
limitno
label_filterno
kg_schema

Get complete KG schema — labels, relationships, properties.

kg_subgraph

Extract subgraph around a node within radius.

ParameterRequired
node_idyes
radiusno
kg_filter

Filter nodes by label and property conditions.

ParameterRequired
labelyes
conditionsno
limitno
kg_query

Run a read-only Cypher query against the Knowledge Graph.

ParameterRequired
cypheryes
paramsno
kg_stats

Quick summary: total nodes, edges, top labels, top relationship types.

kg_delivery_snapshot

Delivery feasibility snapshot — orders with materials, stock, machine capacity, OEE, customer info.

ParameterRequired
days_aheadno
kg_generate_chart

Generate a Chart.js visualization from a natural language question about the KG.

ParameterRequired
questionyes

UNS (MQTT)

8 tools

Live machine data via MQTT: status, values, categories, alerts, comparisons

uns_list_machines

List all machines currently publishing UNS data via MQTT.

uns_get_machine_status

Get all current UNS values for a machine: BDE, ProcessData, OEE, Status.

ParameterRequired
machineyes
uns_get_value

Read a single UNS topic value by full topic path.

ParameterRequired
topicyes
uns_get_category

Get all values of a data category for a machine (BDE, ProcessData, QMS, WMS).

ParameterRequired
machineyes
categoryyes
uns_search_topics

Search UNS topics by pattern with wildcards (* = single level, # = multi level).

ParameterRequired
patternyes
uns_get_alerts

Show all UNS values with non-good quality (faults, warnings, bad readings).

uns_get_history

Get last N values of a UNS topic from ring buffer — shows trend.

ParameterRequired
topicyes
countno
uns_compare_machines

Compare the same variable across multiple machines.

ParameterRequired
machinesyes
variableyes

Discovery

2 tools

Auto-discovered machines and sensors from MQTT UNS

kg_discovered_machines

All machines auto-discovered from MQTT UNS.

kg_machine_sensors

All sensors on a discovered machine with last values.

ParameterRequired
machineyes

This site uses a cookie to remember your preferences. Analytics are anonymous and cookie-free. Privacy Policy