test_connection
Verify connectivity to the Wakapi server by testing the API endpoint and retrieving project data to confirm proper setup and access.
Instructions
Test Wakapi server connection via simple API call to fetch projects.
Returns: A dictionary with the connection test result, including: - status (str): 'success' or 'error'. - message (str): Description of the result. - projects_count (int, optional): Number of projects if successful. - server_url (str): The Wakapi server URL. - api_path (str): The API path used for requests. - error (str, optional): Error message if failed.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/mcp_tools/connection.py:9-52 (handler)The test_connection tool handler: an async function that tests the Wakapi server connection by fetching projects. It returns success or error status with details. Registered via @app.tool decorator.
@app.tool async def test_connection() -> dict[str, Any]: """Test Wakapi server connection via simple API call to fetch projects. Returns: A dictionary with the connection test result, including: - status (str): 'success' or 'error'. - message (str): Description of the result. - projects_count (int, optional): Number of projects if successful. - server_url (str): The Wakapi server URL. - api_path (str): The API path used for requests. - error (str, optional): Error message if failed. """ logger = get_logger("connection_tool") from mcp_tools.dependency_injection import get_wakapi_client logger.info("Starting connection test", method="test_connection") client = get_wakapi_client() try: # Test connection with a simple API call projects = await client.get_projects() logger.debug( f"Projects type: {type(projects)}, data length: " f"{len(projects.data) if hasattr(projects, 'data') else 'No data attr'}" ) return { "status": "success", "message": f"Successfully connected to Wakapi server " f"({client.config.base_url})", "projects_count": len(projects.data), "server_url": client.config.base_url, "api_path": client.config.api_path, } except Exception as e: return { "status": "error", "message": f"Failed to connect to Wakapi server: {e!s}", "server_url": client.config.base_url, "api_path": client.config.api_path, "error": str(e), } - main.py:151-153 (registration)Explicit import of the test_connection function within initialize_tools() to trigger its automatic registration via the @app.tool decorator.
from mcp_tools.connection import test_connection _ = test_connection # Trigger registration