Skip to main content
Glama

test_config

Verify configuration settings and API connectivity for Radarr/Sonarr media management systems.

Instructions

Test the current configuration and API connectivity.

Returns: Configuration status and basic connectivity tests

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler function for the 'test_config' MCP tool. It tests the server configuration and Radarr connectivity, returning a status dictionary. Registered via the @mcp.tool decorator.
    @mcp.tool
    async def test_config() -> Dict[str, Any]:
        """
        Test the current configuration and API connectivity.
        
        Returns:
            Configuration status and basic connectivity tests
        """
        logger.info("Testing configuration...")
        
        if not config:
            return {"error": "No configuration loaded"}
        
        status = {
            "config_loaded": True,
            "radarr_url": config.radarr_url,
            "sonarr_url": config.sonarr_url,
            "radarr_api_key_set": bool(config.radarr_api_key),
            "sonarr_api_key_set": bool(config.sonarr_api_key),
            "tvdb_api_key_set": bool(config.tvdb_api_key),
            "quality_profile_id": config.quality_profile_id,
            "radarr_root_folder": config.radarr_root_folder,
            "sonarr_root_folder": config.sonarr_root_folder
        }
        
        # Test Radarr connectivity
        if config.radarr_api_key:
            try:
                api = MediaServerAPI(config)
                test_results = await api.search_radarr_movies("test")
                status["radarr_search_connectivity"] = "success"
                status["radarr_test_results"] = len(test_results)
            except Exception as e:
                status["radarr_search_connectivity"] = "failed"
                status["radarr_search_error"] = str(e)
        else:
            status["radarr_search_connectivity"] = "no_api_key"
        
        return status
Behavior3/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. It mentions the tool tests configuration and connectivity and returns status/test results, which covers basic behavior. However, it lacks details on execution time, error handling, or whether it modifies anything (though implied as read-only).

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 extremely concise and well-structured: the first sentence states the purpose, and the second clarifies the return value. Every sentence adds value with zero waste, making it easy to parse.

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

Completeness4/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 with an output schema), the description is reasonably complete. It explains what the tool does and what it returns, though it could benefit from more behavioral context like error cases or execution constraints.

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 doesn't add parameter details, but this is appropriate given the schema's completeness, justifying a baseline score above minimum viable.

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 ('Test') and resource ('current configuration and API connectivity'), making it immediately understandable. However, it doesn't explicitly differentiate this tool from sibling tools like 'get_server_status', which might have overlapping functionality.

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, timing, or compare it to sibling tools like 'get_server_status', leaving the agent with no context for tool selection.

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/omniwaifu/arr-assistant-mcp'

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