romm-mcp
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@romm-mcp list all my Game Boy ROMs and update their names"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
RomM MCP
romm-mcp is a community-maintained Model Context Protocol (MCP) server for bounded management of RomM through RomM's authenticated API. It is not affiliated with, endorsed by, or maintained by the RomM project.
The server is intentionally narrower than the complete RomM API: it provides explicit typed read/write tools for common library-management tasks without a generic HTTP passthrough or broad administrative escape hatch.
Status and compatibility
Initial release line:
0.1.x.Tested against RomM
5.1.0API contracts.Requires Python
3.12or newer.Uses RomM Client API Tokens (
rmm_...) as bearer credentials.
Later RomM versions may remain compatible, but they are not claimed as tested until verified.
Related MCP server: nexus-mcp
Capability boundary
Included in v0.1:
Platform and ROM discovery.
Bounded ROM text metadata updates (
name,name_sort_key,summary).Personal ROM status/rating/completion properties.
ROM notes.
Regular collections and collection membership.
Smart collections with an explicit RomM 5.1 filter schema.
User visibility and play-session reads.
Intentionally excluded from v0.1:
Generic API/HTTP passthrough.
ROM or ROM-file deletion.
ROM/file uploads or replacement.
Remote cover/manual fetching and asset mutation.
Library scans, background tasks and bulk metadata refresh.
Platform/system configuration mutation.
Client-token administration.
User, permission-group or authorization mutation.
Device/sync mutation.
Removing ROMs from a collection only changes collection membership. Deleting a regular collection requires confirm=true; RomM also removes that collection's own managed artwork/resource directory, but ROM files are never deleted by this MCP.
See docs/tools.md for the complete 26-tool surface and per-tool side effects.
Installation
Releases are distributed as immutable GitHub Release wheels. romm-mcp is not currently published to PyPI.
For v0.1.1:
uvx --python 3.12 \
--from https://github.com/X1pheR/romm-mcp/releases/download/v0.1.1/romm_mcp-0.1.1-py3-none-any.whl \
romm-mcpEach release includes SHA256SUMS. For pinned or production use, verify the wheel digest before deployment and, where supported, pin the artifact URL with its SHA-256 hash.
Configuration
The server requires a dedicated RomM Client API Token stored in a file. Token values are never accepted as MCP tool arguments.
ROMM_BASE_URL=https://romm.example.com
ROMM_API_TOKEN_FILE=/path/to/romm-api-token
ROMM_TIMEOUT_SECONDS=15ROMM_BASE_URL must be an absolute http:// or https:// URL. ROMM_TIMEOUT_SECONDS must be greater than 0 and at most 300 seconds.
For the complete v0.1 toolset, the intended RomM scope set is:
me.read
platforms.read
roms.read
roms.write
roms.user.read
roms.user.write
collections.read
collections.write
users.readusers.write, task execution, platform-write, device-write and asset-write scopes are not required by v0.1.
MCP client example
{
"command": "uvx",
"args": [
"--python",
"3.12",
"--from",
"https://github.com/X1pheR/romm-mcp/releases/download/v0.1.1/romm_mcp-0.1.1-py3-none-any.whl",
"romm-mcp"
],
"env": {
"ROMM_BASE_URL": "https://romm.example.com",
"ROMM_API_TOKEN_FILE": "/path/to/romm-api-token",
"ROMM_TIMEOUT_SECONDS": "15"
}
}Security model
The RomM Client API Token and its upstream scopes are the hard authorization boundary. Use a dedicated token and grant only the scopes required by the tools you intend to expose.
The MCP layer adds a second boundary:
Credentials are file-backed and omitted from tool schemas.
Every upstream JSON response crosses a centralized recursive sanitizer that redacts credential-like fields and credential-bearing URL query parameters, including nested error payloads.
Every exposed tool then returns a bounded allow-listed response model instead of raw RomM API objects; provider metadata, filesystem internals, unnecessary authorization details and unrelated PII are excluded.
There is no generic request tool.
Remote cover/manual URLs are not accepted, avoiding server-side asset fetch/write behavior through this MCP.
Note, regular-collection and smart-collection deletion require explicit
confirm=true.ROM/file deletion, uploads, task execution and authorization administration are absent from the tool registry.
See SECURITY.md for vulnerability reporting and credential-handling guidance.
Development
uv.lock is the canonical exact dependency resolution used by CI and release verification, while the published package keeps compatible dependency ranges in pyproject.toml.
bash ./scripts/verify.shThe verification script creates an isolated Python 3.12 environment, synchronizes the frozen uv.lock resolution, compiles the package, runs the test suite and builds the release wheel.
Upstream and license
This repository is an independent community integration for RomM. RomM is a separate upstream project governed by its own license and project policies.
romm-mcp is licensed under the MIT License.
Available Tools
26 toolsadd_roms_to_collectionA
Add ROM IDs to an existing collection.
Inputs: rom_ids (required), collection_id (required). Returns: ok, action, rom_ids, resource_id, +1 more
create_collectionA
Create a normal RomM collection without uploading artwork.
Inputs: name (required), is_public, description, is_favorite. Returns: id, name, is_public, rom_count, +5 more
create_rom_noteC
Create a RomM note with explicit supported fields.
Inputs: title (required), rom_id (required), tags, content, +1 more. Returns: id, tags, title, rom_id, +6 more
create_smart_collectionB
Create a smart collection from explicit RomM filter criteria.
Inputs: name (required), filter_criteria (required), is_public, description. Returns: id, name, is_public, rom_count, +7 more
delete_collectionADestructive
Delete a collection after explicit confirmation; ROM files are never deleted.
Inputs: collection_id (required), confirm. Returns: ok, action, rom_ids, resource_id, +1 more
delete_rom_noteADestructive
Delete one RomM note after explicit confirmation. This does not delete ROM files.
Inputs: rom_id (required), note_id (required), confirm. Returns: ok, action, rom_ids, resource_id, +1 more
delete_smart_collectionADestructive
Delete a smart collection definition after explicit confirmation; this does not delete ROM files.
Inputs: collection_id (required), confirm. Returns: ok, action, rom_ids, resource_id, +1 more
get_collectionBRead-onlyIdempotent
Get one compact normal RomM collection.
Inputs: collection_id (required). Returns: id, name, is_public, rom_count, +5 more
get_platformARead-onlyIdempotent
Get a compact RomM platform summary by internal ID.
Inputs: platform_id (required). Returns: id, name, slug, category, +5 more
get_romARead-onlyIdempotent
Get one bounded ROM view without provider internals, filesystem details, hashes or credential URLs.
Inputs: rom_id (required). Returns: id, name, slug, tags, +24 more
get_smart_collectionCRead-onlyIdempotent
Get one bounded RomM smart collection.
Inputs: collection_id (required). Returns: id, name, is_public, rom_count, +7 more
get_userARead-onlyIdempotent
Get minimal RomM user identity; authorization and UI/device details are excluded.
Inputs: user_id (required). Returns: id, enabled, username
healthARead-onlyIdempotent
Verify authenticated RomM API access and return non-sensitive connectivity identity only.
Inputs: no named parameters. Returns: ok, user_id, username, authenticated, +1 more
list_collectionsARead-onlyIdempotent
List compact normal RomM collections.
Inputs: no named parameters. Returns: count, items, limit, total, +1 more
list_platformsARead-onlyIdempotent
List compact RomM platform summaries visible to the token.
Inputs: no named parameters. Returns: count, items, limit, total, +1 more
list_play_sessionsARead-onlyIdempotent
List bounded play-session summaries for the token owner without device/sync internals.
Inputs: limit, offset. Returns: count, items, limit, total, +1 more
list_rom_notesARead-onlyIdempotent
List up to 100 bounded notes attached to a ROM.
Inputs: rom_id (required). Returns: count, items, limit, total, +1 more
list_romsARead-onlyIdempotent
Search/list ROMs with bounded pagination and a compact provider-internal-free response.
Inputs: limit, offset, matched, missing, +7 more. Returns: count, items, limit, total, +1 more
list_smart_collectionsBRead-onlyIdempotent
List compact RomM smart collections with only the explicit supported filter schema.
Inputs: no named parameters. Returns: count, items, limit, total, +1 more
list_usersARead-onlyIdempotent
List minimal user identity needed for follow-up calls; email, roles, OAuth scopes and UI/device settings are excluded.
Inputs: no named parameters. Returns: count, items, limit, total, +1 more
remove_roms_from_collectionA
Remove ROM IDs from a collection without deleting ROMs.
Inputs: rom_ids (required), collection_id (required). Returns: ok, action, rom_ids, resource_id, +1 more
update_collectionB
Update collection metadata/membership without artwork changes.
Inputs: collection_id (required), name, rom_ids, is_public, +1 more. Returns: id, name, is_public, rom_count, +5 more
update_rom_metadataB
Update bounded text metadata only; asset fetch/write and provider-ID mutation are excluded.
Inputs: rom_id (required), name, summary, name_sort_key. Returns: id, name, slug, tags, +24 more
update_rom_noteC
Update only the explicit fields supported by RomM notes.
Inputs: rom_id (required), note_id (required), tags, title, +2 more. Returns: id, tags, title, rom_id, +6 more
update_rom_user_propertiesA
Update personal ROM status/rating/completion properties for the token owner.
Inputs: rom_id (required), hidden, rating, status, +3 more. Returns: hidden, rating, rom_id, status, +3 more
update_smart_collectionD
Update a smart collection.
Inputs: collection_id (required), name, is_public, description, +1 more. Returns: id, name, is_public, rom_count, +7 more
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 26 tools
Each tool targets a distinct resource/action pair: normal collections and smart collections are clearly separated, ROM metadata updates are distinct from user-property updates, and list/get operations are consistently paired. No two tools appear to do the same thing, and the collection membership tools are clearly differentiated from collection deletion.
The vast majority of tools follow a consistent snake_case verb_noun pattern such as list_roms, create_rom_note, and update_smart_collection. The main deviation is 'health', which is a noun rather than a verb_noun name, and the add/remove membership tools use a slightly different prepositional pattern, though they are internally consistent with each other.
26 tools is just above the heavy range, but the count is defensible because the surface spans platforms, ROMs, notes, normal collections, smart collections, users, and play sessions. Still, the separate normal/smart collection CRUD groups and the split between ROM metadata and user properties make the tool set feel borderline over-scoped.
Normal collections, smart collections, and notes have full lifecycle coverage, while ROMs support listing, fetching, metadata updates, and user-property updates. The main gap is intentional: there is no ROM file create/delete/upload functionality, and play sessions are list-only, but these exclusions are consistent with the safety bounds described in the tool definitions.
Maintenance
Related MCP Connectors
Publish and discover MCP servers via the official MCP Registry. Powered by HAPI MCP server.
Market data tools for the MCP ecosystem: server stats, events, search, leaderboards, package trends.
The official MCP Server for the Mux API
An MCP server that provides read access to your cloud storage providers, bank accounts and more.
Related MCP Servers
- AlicenseAqualityBmaintenance10 tool MCP server for RomM. Adds searching, metadata, tracking, saves and management via MCP.286MIT
- AlicenseNot gradedqualityCmaintenanceA local MCP server for Nexus Mods mod discovery and research, backed by the v2 GraphQL API, enabling search of games, mods, collections, and users.90 npm1ISC
- AlicenseAqualityDmaintenanceA Model Context Protocol (MCP) server that provides tools to query the official MCP Registry.446 npm3MIT
- FlicenseBqualityDmaintenanceA safety-first local MCP server for ROM reverse-engineering, enabling project status checks, file verification, Bakugan DS build/quality tasks, and read-only DeSmuME/ARM9 debugging.52-