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.1.tar.gz (6.6 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.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ivoryos_mcp-0.1.1.tar.gz
  • Upload date:
  • Size: 6.6 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.1.tar.gz
Algorithm Hash digest
SHA256 e0098e3aad90bd255b9b2c7e5646ac95e6ce737637a91f00d6faef672594821c
MD5 e5d201b0ce12eff0266a46ee8c9f8df7
BLAKE2b-256 afdc5d7d394b37b3287c008c31430aef368a68c733f459eefa91ced4e55389bd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ivoryos_mcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 365126e0f9de8f7fb2a9d40526d945ee061b48181e088eef5bdad36117d1c48b
MD5 3c975433d4db1b5c7098a602a0457707
BLAKE2b-256 2f476438583ab3e5938d26e71ed11483c7dfd6d507fa8022a27f4fd239ce9ed0

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