is_player_online
Check if a Chess.com player is currently online by providing their username. Get a real-time status update on player activity.
Instructions
Check if a player is currently online on Chess.com
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- src/chess_mcp/server.py:113-125 (handler)The is_player_online async function decorated with @mcp.tool that makes an API request to the Chess.com 'player/{username}/is-online' endpoint.
@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:113-113 (registration)The @mcp.tool decorator registers is_player_online as an MCP tool with FastMCP.
@mcp.tool(description="Check if a player is currently online on Chess.com") - src/chess_mcp/server.py:26-80 (helper)The make_api_request helper that is called by is_player_online to perform the actual HTTP GET request to the Chess.com API.
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