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.

🚀 Quickstart with Claude Desktop

Install uv. Open up the configuration file, and add IvoryOS MCP config.

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "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>"
      }
    }
  }
}

📦 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 Route Description
ℹ️ General Tools platform-info GET /api/control Get ivoryOS info and signature of the platform
execution-status GET /api/runner/status Check if system is busy and current/last task status
ℹ️ Workflow Design list-workflow-scripts GET /database/scripts/<deck_name> List all workflow scripts from the database
load-workflow-script GET /database/scripts/edit/<script_name> Load a workflow script from the database
submit-workflow-script POST /api/design/submit Save a workflow Python script to the database
ℹ️ Workflow Data list-workflow-data GET /database/workflows/ List available workflow execution data
load-workflow-data GET /database/workflows/<workflow_id> Load execution log and data file
🤖 Direct Control execute-task POST /api/control Call platform function directly
🤖 Workflow Run run-workflow-repeat POST /design/campaign Run workflow scripts repeatedly with static parameters
run-workflow-kwargs POST /design/campaign Run workflow scripts with dynamic parameters
run-workflow-campaign POST /design/campaign Run workflow campaign with an optimizer
🤖 Workflow Control pause-and-resume GET /api/runner/pause Pause or resume the workflow execution
abort-pending-workflow GET /api/runner/abort_pending Finish current iteration, abort future executions
stop-current-workflow GET /api/runner/abort_current Safe stop of current workflow

⚠️ ℹ️ are resources, but decorated as tool due to the current issue with MCP Python SDK and Claude Desktop integration.
It's recommended to only use allow always for ℹ️ tasks
and use allow once for 🤖 tasks. 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.5.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.5-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ivoryos_mcp-0.1.5.tar.gz
Algorithm Hash digest
SHA256 919c61ac05d5ee33db434143c027df34ab1a19ad214f3ed08a60d1de75b11c95
MD5 4880b397af835afe0bfac4ae36cb992b
BLAKE2b-256 66a3a95a429488db857656b1d9cc1b69b72fb0a397e01f24245cba9358438bce

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ivoryos_mcp-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 737953cc1a0ce7cb1029238e1001c6715c55494c29de4fe3a4bae246c448c52e
MD5 e869b53bf3053249cff9e5f53b4ac8f1
BLAKE2b-256 a43814b0264cd678a14e669dd43b6454938f9d755b5e9b185f0b49cd84e98fe4

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