Skip to main content
Glama

romm_status

Check RomM MCP server configuration and reachability to verify system status and connectivity for management operations.

Instructions

Check RomM MCP server configuration and reachability.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function `romm_status` that fetches the RomM heartbeat/status information.
    async def romm_status() -> str:
        """Check RomM MCP server configuration and reachability."""
        lines = ["RomM MCP Status:\n"]
        lines.append(f"  URL: {cfg.romm_url}")
        lines.append(f"  Username: {cfg.romm_username}")
        lines.append(f"  TLS verify: {cfg.tls_verify}")
        lines.append(f"  Timeouts: {cfg.request_timeout}s / {cfg.request_timeout_long}s (long)\n")
    
        if not cfg.configured:
            lines.append("  Status: NOT CONFIGURED (set ROMM_USERNAME + ROMM_PASSWORD)")
            return "\n".join(lines)
    
        try:
            data = await _get("heartbeat", auth_required=False)
            if isinstance(data, dict):
                system = data.get("SYSTEM", {})
                meta = data.get("METADATA_SOURCES", {})
                fs = data.get("FILESYSTEM", {})
    
                lines.append("  Connected: yes")
                lines.append(f"  Version: {system.get('VERSION', '?')}")
                lines.append(f"  IGDB enabled: {meta.get('IGDB_API_ENABLED', False)}")
                lines.append(f"  ScreenScraper enabled: {meta.get('SS_API_ENABLED', False)}")
                lines.append(f"  HLTB enabled: {meta.get('HLTB_API_ENABLED', False)}")
                platforms = fs.get("FS_PLATFORMS", [])
                lines.append(f"  Filesystem platforms: {len(platforms)}")
            else:
                lines.append("  Connected: yes (unexpected response format)")
        except Exception as e:
            lines.append(f"  Status: UNREACHABLE — {e}")
  • server.py:299-299 (registration)
    The MCP tool registration for `romm_status`.
    @mcp.tool()
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool checks 'configuration and reachability,' implying a read-only diagnostic operation, but doesn't specify details like whether it requires authentication, returns error states, or has rate limits. This leaves gaps in understanding the tool's behavior.

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 a single, efficient sentence that directly states the tool's purpose with no wasted words. It is front-loaded and appropriately sized for a simple diagnostic tool, making it easy for an agent to parse quickly.

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

Completeness3/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 adequate but minimal. It covers the basic purpose but lacks details on behavioral aspects like error handling or output interpretation, which could be important for a configuration check tool, even with an output schema.

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 tool has 0 parameters, and schema description coverage is 100%, so there's no need for parameter explanation in the description. The description appropriately focuses on the tool's purpose without redundant parameter details, earning a high baseline score for zero-parameter tools.

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

Purpose4/5

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

The description clearly states the tool's purpose with a specific verb ('Check') and resource ('RomM MCP server configuration and reachability'), making it immediately understandable. However, it doesn't explicitly differentiate itself from sibling tools like 'romm_stats' or 'romm_tasks', which might also provide status-related information, preventing a perfect score.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, context for usage, or compare it to siblings like 'romm_stats' for broader statistics or 'romm_tasks' for ongoing processes, leaving the agent without usage direction.

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