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.4.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.4-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ivoryos_mcp-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 44d0e72bcbd28ac7c0c56d20cb5a578bf6b2d48437ecd559c9027bffe2aea457
MD5 1738d98228729ff2c0d7c7319accfa19
BLAKE2b-256 b75a3a7046b879eab178ff0c78fffb99c4b25804134de0e99af216fad8aaf0ec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ivoryos_mcp-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9facf0ed8b6c4084c94d67fbdeb5b2494b622a22b7b29e23d086fde8d88843e7
MD5 c64fbc7b671422cb796e20e16cd3f892
BLAKE2b-256 c4c66c07364d358403731e2353180a19e2942e7bcfe2b930b478e3f0705adaca

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