Skip to main content

MCP server for ivoryOS.

Project description

IvoryOS MCP server

License: MIT

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

status.gif

Load prebuilt workflow script

load script.gif

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ivoryos_mcp-0.1.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ivoryos_mcp-0.1.0-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file ivoryos_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: ivoryos_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ivoryos_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8c194227f73048f696e00022dc67a6fdfc789954e9e104443d59c96898aec614
MD5 b17e42fd97eaca31fb4f82e435954d01
BLAKE2b-256 78fbf8a4ed8224d987233321a1124e81cfcccde2aa794513c2bf2289e592fd7e

See more details on using hashes here.

File details

Details for the file ivoryos_mcp-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ivoryos_mcp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for ivoryos_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e69bc668e779bea76d32e44b6a688d1ef487b5e6e0380a5deb3a550a892ce6c6
MD5 0d6dad873ac508060ae89b9a1fcd298b
BLAKE2b-256 46255e00aa5669aec2908591c21b108c94717377c331b197a490e2d366884ea1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page