Skip to main content
Glama

romm_scan_library

Trigger a library rescan to discover new ROMs and platforms. This background task updates your collection as it scans.

Instructions

Trigger a library rescan to discover new ROMs and platforms.

This is a background task — it returns immediately. New ROMs will appear in the library as the scan progresses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The romm_scan_library tool handler which triggers a POST request to the RomM tasks API to scan the library.
    @mcp.tool()
    async def romm_scan_library() -> str:
        """Trigger a library rescan to discover new ROMs and platforms.
    
        This is a background task — it returns immediately. New ROMs will appear
        in the library as the scan progresses.
        """
        try:
            data = await _post("tasks/run/scan_library", long_timeout=True)
            if isinstance(data, dict):
                job_id = data.get("id", "")
                status = data.get("status", "started")
                return f"Library scan triggered (job: {job_id}, status: {status})."
            return "Library scan triggered."
        except RuntimeError as e:
            if "422" in str(e) or "not enabled" in str(e).lower():
                return "Library scan task is not enabled in RomM settings. Enable scheduled rescan first."
            raise
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden and adds valuable behavioral context: it discloses that this is a 'background task' that 'returns immediately' and that new ROMs appear 'as the scan progresses.' This clarifies the asynchronous nature and expected behavior, though it doesn't mention potential side effects like performance impact or error handling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose in the first sentence, followed by key behavioral details in the second. Both sentences earn their place by providing essential information without redundancy, making it highly efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (0 parameters, no annotations, but has an output schema), the description is complete enough. It explains what the tool does, its asynchronous behavior, and the outcome, which suffices for an agent to invoke it correctly. The output schema likely handles return values, so no need to detail them here.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description appropriately doesn't discuss parameters, focusing instead on the tool's behavior. A baseline of 4 is applied since no parameters exist, and the description doesn't add unnecessary details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Trigger a library rescan') and resource ('ROMs and platforms'), distinguishing it from sibling tools like romm_library_items (which likely lists items) or romm_search (which searches existing items). It explicitly mentions the outcome ('discover new ROMs and platforms'), making the purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context on when to use it: to discover new ROMs and platforms, implying it's for updating the library after adding files. However, it doesn't explicitly state when not to use it (e.g., if a scan is already in progress) or name alternatives among siblings, though the context suggests it's unique for triggering scans.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/lodordev/mcp-romm'

If you have feedback or need assistance with the MCP directory API, please join our Discord server