← Docs Hub

Getting Started

Registration, your first flow, your first agent

What is OpenShopFloor?

OpenShopFloor (OSF) is an open-source factory AI sandbox. It provides a complete manufacturing simulation with real-time machine data, production orders, quality metrics, and tool management — all accessible through 118 MCP (Model Context Protocol) tools. You can build AI agents that monitor, analyze, and optimize factory operations.

1. Create an Account

Go to openshopfloor.zeroguess.ai/register and create a free account. You'll need an email address and password. After registration you're automatically logged in and can start exploring.

Info
OSF is free to use. No credit card required. Your account gives you access to all features including the chat, agents, flows, and the full MCP tool suite.

2. Explore the Chat

The quickest way to interact with the factory is through the AI Chat. The chat assistant has access to all 118 MCP tools and can answer questions about your factory in real time:

  • "What's the current OEE across all machines?"
  • "Show me all open production orders"
  • "Are there any quality issues today?"
  • "Which machines are idle right now?"

The assistant will call the appropriate MCP tools, retrieve live data from the factory simulation, and present the results with analysis.

3. Run Your First Agent

Agents are pre-built AI routines that perform specific factory tasks. Go to Agents and try one of the built-in agents:

  • OEE Optimizer — Analyzes OEE data and suggests improvements
  • Quality Guard — Monitors defect rates and identifies quality issues
  • Delivery Tracker — Checks at-risk orders and suggests corrective actions

Click "Run" on any agent to see it execute. The output streams in real time as the agent calls MCP tools and analyzes data.

4. Build Your First Flow

Flows let you chain multiple AI operations in a visual editor. Go to Flows and click "Open Editor" to launch the Node-RED-based flow editor.

  1. Drag an osf-mcp-fertigung node onto the canvas
  2. Configure it to call factory_get_latest_oee
  3. Add an osf-prompt node and connect it
  4. Set the prompt to: "Analyze this OEE data: {{input}}"
  5. Save and run — watch the LLM analyze your factory data
Tip
Check the Visual Flows Guide for a complete walkthrough of all node types and patterns.

5. Deploy a Code Agent

For more complex logic, write a TypeScript agent and deploy it from GitHub:

  1. Connect your GitHub account in Settings
  2. Create a repo with osf-agent.yaml and src/main.ts
  3. Deploy from Agents → Deploy from GitHub
Tip
See the Code Agents Guide for the full SDK reference and examples.

Next Steps

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