IvoryOS MCP

by ivoryzh

221 downloads Not rated yet

GitHub

Other

About

IvoryOS is a Python-based unified robot control web interface, developed for user-friendly workflow design and control for Self-Driving Labs (SDLs). It works by introspecting the Python script, dynamically searching for available module and their method. The methods are available

Explore

| Category | Feature | Description |
|-------------------------|--------------------------|--------------------------------------------------------|
| ℹ️ General Tools | platform-info | Get ivoryOS info and signature of the platform |
| | execution-status | Check if system is busy and current/last task status |
| ℹ️ Workflow Design | list-workflow-scripts | List all workflow scripts from the database |
| | load-workflow-script | Load a workflow script from the database |
| | submit-workflow-script | Save a workflow Python script to the database |
| ℹ️ Workflow Data | list-workflow-data | List available workflow execution data |
| | load-workflow-data | Load CSV and execution log from selected workflow |
| 🤖 Direct Control | execute-task | Call platform function directly |
| 🤖 Workflow Run | run-workflow-repeat | Run workflow scripts repeatedly with static parameters |
| | run-workflow-kwargs | Run workflow scripts with dynamic parameters |
| | run-workflow-campaign | Run workflow campaign with an optimizer |
| 🤖 Workflow Control | pause-and-resume | Pause or resume the workflow execution |
| | abort-pending-workflow | Finish current iteration, abort future executions |
| | stop-current-workflow | Safe stop of current workflow |

> ⚠️ It's recommended to only use allow always for tasks with ℹ️
> and use allow once for tasks with 🤖.
> These tasks will trigger actual actions on your hosted Python code.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name IvoryOS MCP

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

From the repository

Install uv.

When using IDE (e.g. PyCharm), the uv environment might be configured, you can skip this section.

python -m venv .venv

source .venv/bin/activate  # On Windows: .venv\Scripts\activate

uv pip install -r uv.lock

Option 1: in .env, change ivoryOS url and login credentials.

IVORYOS_URL=http://127.0.0.1:8000/ivoryos

IVORYOS_USERNAME=admin

IVORYOS_PASSWORD=admin

Option 2: In ivoryos_mcp/server.py, change ivoryOS url and login credentials.

url = "http://127.0.0.1:8000/ivoryos"

login_data = {

    "username": "admin",

    "password": "admin",

}

mcp install ivoryos_mcp/server.py

`platform-info`

summarize ivoryOS and the current deck functions, no authentication required.

`execution-status`

Get workflow status

`execute-task`

Execute a robot task and return task_id.

`list-workflow-scripts`

List workflow scripts

`load-workflow-script`

Load a workflow script

`submit-workflow-script`

Submit a workflow script

`pause-and-resume`

Toggle pause and resume for workflow execution

`abort-pending-workflow`

Abort pending workflow execution

`stop-current-workflow`

Stop workflow execution after current step

`run-workflow-repeat`

Run the loaded workflow with repeat times

`run-workflow-kwargs`

Run the loaded workflow with a list of keyword arguments

`run-workflow-campaign`

Run the loaded workflow with ax-platform (credit: Honegumi)

`list-workflow-data`

List workflow data

`load-workflow-data`

Load workflow data

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "ivoryos mcp": {
            "IvoryOS MCP": {
                "command": "uvx",
                "args": [
                    "ivoryos-mcp"
                ],
                "env": {
                    "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
                    "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
                    "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
                }
            }
        }
    }
}

McpServers

{
    "IvoryOS MCP": {
        "command": "uvx",
        "args": [
            "ivoryos-mcp"
        ],
        "env": {
            "IVORYOS_URL": "http://127.0.0.1:8000/ivoryos",
            "IVORYOS_USERNAME": "<IVORYOS_USERNAME>",
            "IVORYOS_PASSWORD": "<IVORYOS_PASSWORD>"
        }
    }
}

![](https://badge.mcpx.dev?type=server 'MCP Server')

Serve as a robot control interface using IvoryOS and Model Context Protocol (MCP) to design, manage workflows, and interact with the current hardware/software execution layer.

📦 Installation

Install uv.

1. Clone the Repository

git clone https://gitlab.com/heingroup/ivoryos-mpc
cd ivoryos-mcp

2. Install dependencies

When using IDE (e.g. PyCharm), the uv environment might be configured, you can skip this section.

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install -r uv.lock

⚙️ Configuration

Option 1: in .env, change ivoryOS url and login credentials.

IVORYOS_URL=http://127.0.0.1:8000/ivoryos
IVORYOS_USERNAME=admin
IVORYOS_PASSWORD=admin

Option 2: In ivoryos_mcp/server.py, change ivoryOS url and login credentials.

url = "http://127.0.0.1:8000/ivoryos"

login_data = {

    "username": "admin",

    "password": "admin",

}

🚀 Install the server (in Claude Desktop)

mcp install ivoryos_mcp/server.py

✨ Features

| Category | Feature | Description | |-------------------------|--------------------------|--------------------------------------------------------| | ℹ️ General Tools | platform-info | Get ivoryOS info and signature of the platform | | | execution-status | Check if system is busy and current/last task status | | ℹ️ Workflow Design | list-workflow-scripts | List all workflow scripts from the database | | | load-workflow-script | Load a workflow script from the database | | | submit-workflow-script | Save a workflow Python script to the database | | ℹ️ Workflow Data | list-workflow-data | List available workflow execution data | | | load-workflow-data | Load CSV and execution log from selected workflow | | 🤖 Direct Control | execute-task | Call platform function directly | | 🤖 Workflow Run | run-workflow-repeat | Run workflow scripts repeatedly with static parameters | | | run-workflow-kwargs | Run workflow scripts with dynamic parameters | | | run-workflow-campaign | Run workflow campaign with an optimizer | | 🤖 Workflow Control | pause-and-resume | Pause or resume the workflow execution | | | abort-pending-workflow | Finish current iteration, abort future executions | | | stop-current-workflow | Safe stop of current workflow |

> ⚠️ It's recommended to only use allow always for tasks with ℹ️
> and use allow once for tasks with 🤖.
> These tasks will trigger actual actions on your hosted Python code.

🧪 Examples

The example prompt uses the abstract SDL example.

Platform info

Load prebuilt workflow script

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Explore

Setting up with Highlight

From the repository

platform-info

execution-status

execute-task

list-workflow-scripts

load-workflow-script

submit-workflow-script

pause-and-resume

abort-pending-workflow

stop-current-workflow

run-workflow-repeat

run-workflow-kwargs

run-workflow-campaign

list-workflow-data

load-workflow-data

Claude Desktop / Cursor

McpServers

📦 Installation

1. Clone the Repository

2. Install dependencies

⚙️ Configuration

🚀 Install the server (in Claude Desktop)

✨ Features

🧪 Examples

Platform info

Load prebuilt workflow script

More like this

Sequential Thinking

Filesystem

EverArt

Google Drive

`platform-info`

`execution-status`

`execute-task`

`list-workflow-scripts`

`load-workflow-script`

`submit-workflow-script`

`pause-and-resume`

`abort-pending-workflow`

`stop-current-workflow`

`run-workflow-repeat`

`run-workflow-kwargs`

`run-workflow-campaign`

`list-workflow-data`

`load-workflow-data`