is_player_online
Check if a Chess.com player is currently online to determine availability for games or communication.
Instructions
Check if a player is currently online on Chess.com
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes |
Implementation Reference
- src/chess_mcp/server.py:113-126 (handler)The main handler function implementing the 'is_player_online' tool logic. It queries the Chess.com API endpoint 'player/{username}/is-online' using the shared make_api_request helper. The @mcp.tool decorator automatically registers it with the MCP server and provides the schema inferred from the signature and docstring.@mcp.tool(description="Check if a player is currently online on Chess.com") async def is_player_online(username: str) -> Dict[str, Any]: """ Check if a player is currently online on Chess.com. Args: username: The Chess.com username Returns: Online status data """ logger.info("Checking player online status", username=username) return await make_api_request(f"player/{username}/is-online")
- src/chess_mcp/server.py:26-81 (helper)Supporting utility function used by the is_player_online handler (and other tools) to make HTTP requests to the Chess.com API, handling JSON/PGN responses and errors.async def make_api_request( endpoint: str, params: Optional[Dict[str, Any]] = None, accept_json: bool = True ) -> Union[Dict[str, Any], str]: """ Make a request to the Chess.com API. Args: endpoint: The API endpoint to request params: Optional query parameters accept_json: Whether to accept JSON response (True) or PGN (False) Returns: JSON response as dict or text response as string Raises: httpx.HTTPError: If the request fails """ url = f"{config.base_url}/{endpoint}" headers = { "accept": "application/json" if accept_json else "application/x-chess-pgn" } logger.debug( "Making API request", endpoint=endpoint, url=url, accept_json=accept_json, has_params=params is not None ) async with httpx.AsyncClient() as client: try: response = await client.get(url, headers=headers, params=params or {}) response.raise_for_status() if accept_json: result = response.json() logger.debug("API request successful", endpoint=endpoint, response_type="json") return result else: result = response.text logger.debug("API request successful", endpoint=endpoint, response_type="text") return result except httpx.HTTPError as e: logger.error( "API request failed", endpoint=endpoint, url=url, error=str(e), error_type=type(e).__name__ ) raise