Skip to main content

MCP server for dosbox-automation: drive a DOS machine from an AI agent

Project description

dosbox-mcp

MCP server for dosbox-automation: drive a DOS machine from an AI agent.

dosbox-automation is a DOSBox fork with a built-in automation API. This bridge connects any MCP-capable agent runtime (Claude Code and friends) to a running emulator. The agent can type into DOS programs, read the screen, capture frames and video, run sandboxed Lua scripts, and inspect memory: everything the automation API offers, as MCP tools.

Quick start

  1. Install dosbox-automation and start it with the API enabled. The manual covers setup for all platforms.

  2. Add the bridge to your MCP client. For Claude Code:

    claude mcp add dosbox -- uvx dosbox-mcp
    

    Or in a JSON MCP configuration:

    {
      "mcpServers": {
        "dosbox": { "command": "uvx", "args": ["dosbox-mcp"] }
      }
    }
    

    pipx install dosbox-mcp or pip install dosbox-mcp work just as well; the command is dosbox-mcp either way.

That's it. The bridge finds the running emulator, checks what it can do, and registers the matching tools. Ask your agent for bridge_status to confirm the connection.

Configuration

Optional. Write a commented config file to tune the port, spawn an emulator on demand, or limit what an agent may do:

dosbox-mcp setup --init

The comments in the generated file explain each setting. Environment variables DOSBOX_API_URL and DOSBOX_API_TOKEN override it. The bridge talks to loopback addresses only; it will not reach out to a remote machine.

What the agent gets

Tools for session control, screen text and captures, video recording, Lua scripting, keyboard and mouse input, and memory access. You choose how much reach an agent has, from read-only observation to full control.

An open protocol

The contract between this bridge and the emulator is written down in PROTOCOL.md and versioned independently. dosbox-automation is the reference implementation; any DOSBox variant that speaks the protocol works with this bridge.

In the box

Like the games it drives, this one ships with its paper. The feelies/ folder holds the manual, a reference card for every tool, an install sheet, and a tech-support page.

Requirements

  • Python 3.11 or newer
  • A running dosbox-automation (0.84-da2 or newer) on the same machine

License

GPL-2.0-or-later. See LICENSE. The protocol specification (PROTOCOL.md) is licensed CC-BY-SA-4.0.


This project is developed with tooled assistance, but tested, reviewed and signed off by a human developer.

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

dosbox_mcp-0.1.0.tar.gz (57.3 kB view details)

Uploaded Source

Built Distribution

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

dosbox_mcp-0.1.0-py3-none-any.whl (47.0 kB view details)

Uploaded Python 3

File details

Details for the file dosbox_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: dosbox_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 57.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for dosbox_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cefd29d6769453db79d2f96c124a7a97b603441e45e2cf1cfa0a3df7e9bc415d
MD5 2d85b3fb8b04ed378fe04e0a21c8da2b
BLAKE2b-256 512f2f29b8b23839dcdbfbb3c9570bae571b154d5be1dff15c06925eefe3c546

See more details on using hashes here.

File details

Details for the file dosbox_mcp-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dosbox_mcp-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 47.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for dosbox_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f3dec5703fc533cb3263cadd80005895c77b9070c7ee4ee9f18b969eb2efa0ef
MD5 d3a712dc15b0e5deb3b3d29d138ab876
BLAKE2b-256 e5e4fe7fcea85a361982d26e978abc38464fcf97f4c08f600ef7d9dddee69f44

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