Skip to main content

MCP server for RomM — browse and manage your retro game library with AI

Project description

RomM MCP Server

An MCP server for RomM — the self-hosted retro game library manager. 28 tools: 19 read-only for browsing platforms, searching ROMs, viewing metadata, collections, saves, and tasks — plus 9 write tools for setting play status, favoriting, notes, and managing collections, through any MCP-compatible AI assistant.

Tools

Read

Tool Description
romm_status Check server configuration and reachability
romm_stats Library-wide statistics (platforms, ROMs, saves, total size)
romm_platforms List platforms with ROM counts and sizes
romm_library_items Browse ROMs with filtering and pagination
romm_recent Recently added or updated ROMs
romm_get_item Full ROM detail — metadata, saves, user status
romm_search Search ROMs by name
romm_search_by_hash Identify a ROM by file hash (CRC, MD5, or SHA1)
romm_filters Available filter values (genres, regions, languages, tags)
romm_collections List user-curated collections
romm_collection_detail List ROMs in a specific collection
romm_smart_collections List auto-generated smart collections
romm_saves List save files by ROM or platform
romm_user_profile Browse by status (now playing, backlog, completed, etc.)
romm_rom_notes View notes on a ROM
romm_firmware List BIOS/firmware files per platform
romm_devices List registered devices
romm_tasks Check running/scheduled task status
romm_scan_library Trigger a background library rescan

Write

These modify your own user data and collections. They cannot alter ROM files, platforms, firmware, other users, or save files.

Tool Description
romm_set_status Set play status, backlog, now-playing, rating, completion, last-played
romm_favorite Add or remove a ROM from your favorites
romm_add_note Add a note to a ROM
romm_update_note Edit an existing note
romm_delete_note Delete a note (permanent)
romm_create_collection Create a new collection
romm_add_to_collection Add ROMs to a collection
romm_remove_from_collection Remove ROMs from a collection
romm_delete_collection Delete a collection — the grouping only, not the ROMs (permanent)

Setup

Prerequisites

  • Python 3.10+
  • A running RomM instance (v4.0+)
  • A RomM user account with admin role

Install

pip install fastmcp httpx

Or clone and install:

git clone https://github.com/lodordev/mcp-romm.git
cd mcp-romm
pip install .

Configure

Set environment variables:

Variable Required Default Description
ROMM_URL No http://localhost:3000 Your RomM instance URL
ROMM_USERNAME Yes RomM username
ROMM_PASSWORD Yes RomM password
ROMM_REQUEST_TIMEOUT No 30 Default request timeout (seconds)
ROMM_REQUEST_TIMEOUT_LONG No 60 Timeout for slow endpoints
ROMM_TLS_VERIFY No true Verify TLS certificates

Add to Claude Code

Add to your .mcp.json:

{
  "mcpServers": {
    "romm": {
      "command": "python",
      "args": ["/path/to/mcp-romm/server.py"],
      "env": {
        "ROMM_URL": "http://your-romm-instance:3000",
        "ROMM_USERNAME": "your-username",
        "ROMM_PASSWORD": "your-password"
      }
    }
  }
}

Add to Claude Desktop

Add to your Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):

{
  "mcpServers": {
    "romm": {
      "command": "python",
      "args": ["/path/to/mcp-romm/server.py"],
      "env": {
        "ROMM_URL": "http://your-romm-instance:3000",
        "ROMM_USERNAME": "your-username",
        "ROMM_PASSWORD": "your-password"
      }
    }
  }
}

Examples

Once configured, you can ask your AI assistant things like:

  • "What platforms do I have in RomM?"
  • "Search for Zelda games"
  • "Show me my backlog"
  • "How many ROMs do I have total?"
  • "What was recently added?"
  • "Show me the saves for Super Metroid"
  • "What's in my favorites?"
  • "List my firmware files for PlayStation"
  • "What tasks are running?"
  • "What devices are registered?"

And, with the write tools:

  • "Mark Chrono Trigger as finished"
  • "Favorite Super Metroid"
  • "Add it to my backlog and rate it 9"
  • "Make a collection called 'SNES RPGs' and add ROMs 10, 11, and 12"
  • "Add a note to this ROM: 'glitch at the second boss, save often'"

Security

  • Least privilege. The OAuth2 token requests only the read scopes the tools use plus roms.user.write, collections.write, and tasks.run. It deliberately does not request roms.write, platforms.write, firmware.write, assets.write, users.write, or me.write — no tool uses them.
  • Bounded write surface. Write tools change only your own user data (play status, favorites, notes) and your own collections. No tool edits ROM files, platforms, firmware, other users, or uploads/deletes save files.
  • Destructive ops are labeled. romm_delete_note and romm_delete_collection permanently remove data and say so in their descriptions. (romm_delete_collection removes the grouping, not the ROMs.)
  • No disk writes. Credentials and tokens are held in memory only, never written to disk.
  • TLS by default. Certificate verification is enabled by default (ROMM_TLS_VERIFY=true).
  • Auto-retry. If a token expires mid-session, the server re-authenticates transparently.

Auth

The server uses OAuth2 password grant to authenticate with RomM. Tokens are scoped to the minimum permissions needed and automatically refreshed when they expire. If a request gets a 401, the server re-authenticates and retries once.

Note: The read and write tools operate on your own library and user data, so an ordinary enabled RomM user account is sufficient — admin is not required. (romm_scan_library does require an account permitted to run tasks.)

License

MIT. See CHANGELOG.md for release history.

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

mcp_romm-1.0.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

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

mcp_romm-1.0.0-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file mcp_romm-1.0.0.tar.gz.

File metadata

  • Download URL: mcp_romm-1.0.0.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_romm-1.0.0.tar.gz
Algorithm Hash digest
SHA256 addcf99b5ab31aed35b422adde42e7979a08b204401c1b14ba788e0b8d60605d
MD5 43cf765b1879a4e72b23d837ad24995a
BLAKE2b-256 bc07699338a9ed20f619e2d4fe8a628aacb28a1bd70c3eac61377fddf7dc4436

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_romm-1.0.0.tar.gz:

Publisher: publish.yml on lodordev/mcp-romm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mcp_romm-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mcp_romm-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mcp_romm-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b8608bf99f58354b36101d1016ad07eea72aad03fcc7dda816e37b8e0b9a57fd
MD5 d77478aab2406bddca64a897e68c2134
BLAKE2b-256 07c6f8be5a98d691232359d32e3c3aac8ae4a939f1232627a94fbe804e85179a

See more details on using hashes here.

Provenance

The following attestation bundles were made for mcp_romm-1.0.0-py3-none-any.whl:

Publisher: publish.yml on lodordev/mcp-romm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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