Skip to main content

Local MCP server for AI agents: local YOLO-based UI-element detection (OmniParser-v2 icon detector) with per-element OCR, hash caching, and full keyboard / mouse / screen / clipboard control via pyautogui + mss.

Project description

   ██╗  ██╗██╗██████╗  █████╗
   ██║ ██╔╝██║██╔══██╗██╔══██╗
   █████╔╝ ██║██████╔╝███████║
   ██╔═██╗ ██║██╔══██╗██╔══██║
   ██║  ██╗██║██║  ██║██║  ██║
   ╚═╝  ╚═╝╚═╝╚═╝  ╚═╝╚═╝  ╚═╝
        local · MCP · computer-use

PyPI Python 3.10+ MCP 1.2+ License: MIT Platforms


kira-mcp is a local Model Context Protocol server that gives any MCP-compatible agent host (Claude Desktop, Claude Code, Cursor, Cline, Continue, …) full computer-use capabilities on the host machine.

Built and tuned for Windows. macOS and Linux are best-effort — most tools work, but some UI conventions differ.

  • Visionperceive_screen is the agent's one-shot "look at the screen" tool. It grabs the current display in memory, runs the local microsoft/OmniParser-v2 YOLO icon-detector on it, and returns an annotated image plus JSON with each element's {id, bbox, cx, cy, confidence} in absolute screen pixels — so the agent can pipe cx, cy straight into mouse_click. No API key, no network call.
  • Desktop automation — pixel-accurate mouse control, keyboard input (incl. chords and key holds), and clipboard read/write via pyautogui, mss, and pyperclip.

The server speaks stdio JSON-RPC and is launched as a child process by your agent host.

Requirements

  • Python 3.10+

  • Platform extras (pyautogui needs them to actually drive input):

    OS Setup
    Windows Nothing extra — primary platform.
    macOS Grant Accessibility permission to the terminal running the server: System Settings → Privacy & Security → Accessibility. First screenshot also prompts for Screen Recording.
    Linux sudo apt install python3-tk python3-dev scrot xdotool (or the equivalent on your distro). X11 sessions only — Wayland blocks raw screen grabs (see Wayland note).

Install

From PyPI (recommended):

pip install kira-mcp

…or, for an isolated global install that won't pollute any project's site-packages:

pipx install kira-mcp

Either form installs the kira-mcp console script and registers every tool module.

The OmniParser-v2 YOLO icon-detector weights (icon_detect/model.pt, ~39 MB) ship inside the wheel — no separate download step. They are loaded and warmed up from disk at server startup.

Working on kira-mcp itself? Clone and install editable: git clone https://github.com/Anmol202005/kira-mcp.git && cd kira-mcp && pip install -e .

If your clone is missing the weights (e.g. a shallow checkout, or you stripped them), restore them with:

hf download microsoft/OmniParser-v2.0 \
  icon_detect/model.pt \
  icon_detect/model.yaml \
  --local-dir src/kira_mcp/weights

Or point to a model.pt elsewhere on disk by setting KIRA_YOLO_WEIGHTS in your environment.

Configure your agent host

Claude Desktop / Claude Code

Add to claude_desktop_config.json (Desktop) or via claude mcp add (Code):

{
  "mcpServers": {
    "kira-mcp": {
      "command": "kira-mcp"
    }
  }
}

Prefer not to rely on the installed script? Use the module form:

{
  "mcpServers": {
    "kira-mcp": {
      "command": "python",
      "args": ["-m", "kira_mcp"]
    }
  }
}

Restart your host. All kira-mcp tools will appear under the kira-mcp namespace.

Cursor / Cline / Continue / Windsurf

Identical shape — point the host's MCP server config at kira-mcp (or python -m kira_mcp).

Tools

Vision

Tool Purpose
perceive_screen One-shot perceive step: screenshots the current display (or a {x, y, width, height} region of it), runs the local OmniParser-v2 YOLO icon-detector on it, and returns BOTH an annotated image inline AND JSON with {width, height, count, elements}. Each element is {id, bbox, cx, cy, confidence} in absolute screen pixels — feed cx, cy directly into mouse_click. Model is loaded and warmed up at server startup, so there is no per-call cold start; typical latency 50-200ms on GPU, 300-800ms on CPU. No API key, no network call.

Mouse

Tool Purpose
mouse_move Move to absolute (x, y). duration=0 for instant.
mouse_position Read the cursor's current (x, y).
mouse_click Click left / middle / right. Optional (x, y) moves first; clicks for multi-click.
mouse_double_click Double-click. Optional (x, y).
mouse_press / mouse_release Hold and later release a button (drag-and-drop primitives).
mouse_drag One-shot: move → press → drag to target → release.
mouse_scroll Scroll up / down / left / right by N clicks.

Keyboard

Tool Purpose
keyboard_type Type literal text.
keyboard_tap Press + release a key chord, e.g. ["ctrl", "c"], ["cmd", "shift", "t"].
keyboard_press / keyboard_release Hold and later release keys (modifier-state primitives).
keyboard_key_check Debug helper — resolve a key name to its pyautogui canonical form.

Key names accept any value from pyautogui.KEYBOARD_KEYS, plus common aliases (ctrl, alt, shift, cmd/command, win/windows/super, meta, esc/escape, enter/return, space/spacebar, pgup/pageup, pgdn/pagedown, del, ins).

Screen

Tool Purpose
screen_size { width, height } of the main display. Useful for bound-checking, though perceive_screen already returns the screen dimensions in its response.

Clipboard

Tool Purpose
clipboard_get Read the system clipboard as text.
clipboard_set Write text to the system clipboard.

Typical agent loop

perceive_screen()                             # → annotated JPEG inline + JSON: {width, height, elements: [{id, bbox, cx, cy, confidence}, …]}
# agent picks an element by id, reads its (cx, cy) — already in absolute screen pixels
mouse_click(x=cx, y=cy)
perceive_screen()                             # verify the action landed

One tool to look, one tool to act, repeat until done.

Layout

src/kira_mcp/
├── __main__.py        # entry — `python -m kira_mcp` or `kira-mcp`
├── _mcp.py            # shared FastMCP instance + system instructions
├── lib/
│   └── keys.py        # key-name normalization for pyautogui
└── tools/
    ├── __init__.py    # side-effect imports → registers tools
    ├── parse.py       # `perceive_screen` — screenshot + local YOLO icon-detector
    ├── screen.py      # `screen_size` + the `Region` model
    ├── mouse.py
    ├── keyboard.py
    └── clipboard.py

Add a new tool by writing a function decorated with @mcp.tool() (imported from kira_mcp._mcp) and importing the module from tools/__init__.py.

Local development

pip install -e .
python -m kira_mcp        # stdio server — drive it from your MCP host

Safety

pyautogui.FAILSAFE is enabled at startup — slamming the mouse to the top-left corner raises FailSafeException and aborts whatever the agent was doing. Leave it on. The server explicitly does not expose a way to disable it from tool calls.

Wayland note

On Linux Wayland sessions, raw X11 screen grabs return a black buffer. GNOME Wayland additionally blocks programmatic screenshots from unprivileged callers. If perceive_screen returns a black image (or no detections at all), log in to an X11 session, or switch to a Wayland compositor that ships wlr-screencopy (Hyprland, Sway, river, Niri) or a KDE Plasma session.

License

MIT — see LICENSE.

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

kira_mcp-0.2.0.tar.gz (37.5 MB view details)

Uploaded Source

Built Distribution

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

kira_mcp-0.2.0-py3-none-any.whl (37.4 MB view details)

Uploaded Python 3

File details

Details for the file kira_mcp-0.2.0.tar.gz.

File metadata

  • Download URL: kira_mcp-0.2.0.tar.gz
  • Upload date:
  • Size: 37.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for kira_mcp-0.2.0.tar.gz
Algorithm Hash digest
SHA256 fa3324b79a513d292605575df072f9eb07de4581dcdcd59cf04d342b60ca7a58
MD5 3b51956d877aeda0bf49dd4683fa07b9
BLAKE2b-256 7250a07ba62a082bd2b21d9d2d1ea0bb3cc56074b91cc976f1ea7d04146b560d

See more details on using hashes here.

File details

Details for the file kira_mcp-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: kira_mcp-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 37.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for kira_mcp-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c73102872563f7658de3370f5dbe1067d839e9726b9f5601e9cb623e194a0ef3
MD5 f01587c5f1716cdf9960ec105a4348a1
BLAKE2b-256 6987ee9e7a556184a19af97320216cc96185d131ae8b7f56317048e58261a72e

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