Skip to main content

Wayland MCP server (Python, uvx-compatible)

Project description

Wayland MCP Server

Status: WIP License: GPT3

Note: This package was created because existing screenshot solutions didn't work reliably on my Wayland setup.
Wayland MCP provides advanced screenshot, analysis, and mouse control tools for modern Linux desktops.


Table of Contents


Features

  • Custom VLM integration for analysis
  • Advanced input simulation:
    • Typing, key presses, clicks
    • Mouse dragging between coordinates
    • Vertical/horizontal scrolling
    • Cross-platform support
  • Screen Capture and VLM Integration: AI-powered screenshot analysis
  • MCP Tools:
    • capture_screenshot: Fullscreen/region capture
    • analyze_screenshot: AI analysis of screenshots
    • capture_and_analyze: Combined capture+analysis
    • compare_images: Visual diff tool

Input Control Setup

⚡ Enabling Mouse Functionality

To enable mouse control features (move, click, drag, scroll), run the setup script:

./wayland_mcp/setup.sh

This script will configure the necessary permissions for evemu-event, allowing the MCP server to control the mouse.


🛠️ MCP Server Environment Configuration

Add the following to the "env" section for your MCP server (e.g., .roo/mcp.json):

{
  "mcpServers": {
    "wayland-screenshot": {
      "command": "uvx",
      "args": [
        "wayland-mcp"
      ],
      "env": {
        "OPENROUTER_API_KEY": "your-api-key",
        "VLM_MODEL": "qwen/qwen2.5-vl-72b-instruct:free",
        "XDG_RUNTIME_DIR": "/run/user/1000",
        "WAYLAND_MCP_PORT": "4999",
        "PYTHONPATH": "wayland_mcp",
        "DISPLAY": ":0",
        "WAYLAND_DISPLAY": "wayland-0",
        "XDG_SESSION_TYPE": "wayland"
      }
    }
  }
}

Development

git clone https://github.com/your-repo/wayland-mcp
cd wayland-mcp
pip install -e .

License

GPT3


Need help?
Open an issue on GitHub or check the project discussions for support.

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

wayland_mcp-0.2.3.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

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

wayland_mcp-0.2.3-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file wayland_mcp-0.2.3.tar.gz.

File metadata

  • Download URL: wayland_mcp-0.2.3.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for wayland_mcp-0.2.3.tar.gz
Algorithm Hash digest
SHA256 63a618f7e08da33cbaba1058a4d18651dd6073811dd8921affe84b60439470f2
MD5 7eee0418b598fb113fa5bf78170f62a0
BLAKE2b-256 ed4ceb6a73e99560842d09bc9bbfb4640731d709267d0c2161de64e34a4fdc9a

See more details on using hashes here.

File details

Details for the file wayland_mcp-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: wayland_mcp-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for wayland_mcp-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fd390f836865b69360258fcdc4221df8a6a61d4d41c0d95b4c64e1fa9ba9ab7a
MD5 41cbf2109d07abe196ffc3627a133bbf
BLAKE2b-256 e8e1a9a1a91e4001aaa58409ae4ad6fb0151ebf69e5495a3d78fac05ddbdb7d4

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