update readme

README.md

@@ -9,3 +9,67 @@ pinned: false
 license: apache-2.0
 short_description: MCP server providing useful tools for chess agents
 ---
+
+# Chess MCP Server
+
+This is a specialized MCP server tailored for chess, designed to enhance interactions with Large Language Models (LLMs) by providing structured chess-related information and analysis.
+
+---
+
+## Overview
+
+The Chess MCP Server offers chess-specific functionalities leveraging powerful chess engines, heuristic evaluations, and opening databases. It is used primarily by chess-related agents such as the [Chess Agent](https://huggingface.co/spaces/Agents-MCP-Hackathon/chess-agent).
+
+## Available API Functions
+
+### 1. **`get_position`**
+
+* **Description:** Analyzes and describes the current chess position, classifies the opening if possible, or provides a piece map and legal moves.
+* **Input:** `{ fen: string }`
+
+### 2. **`get_square_info`**
+
+* **Description:** Retrieves details about a specific square, including the piece occupying it, and identifies attackers and defenders.
+* **Input:** `{ fen: string, square_name: string }`
+
+### 3. **`get_top_moves`** *(Uses Stockfish chess engine)*
+
+* **Description:** Provides top N recommended moves with evaluation scores.
+* **Input:** `{ fen: string, top_n: number }`
+
+### 4. **`analyze_pawn_structure`**
+
+* **Description:** Evaluates pawn structure for both sides from the given position.
+* **Input:** `{ fen: string }`
+
+### 5. **`analyze_tactical_patterns`**
+
+* **Description:** Detects tactical patterns such as forks, pins, skewers, discovered attacks, and x-ray attacks.
+* **Input:** `{ fen: string }`
+
+### 6. **`evaluate_king_safety`**
+
+* **Description:** Assesses the king safety for both sides.
+* **Input:** `{ fen: string }`
+
+### 7. **`classify_opening`**
+
+* **Description:** Classifies chess openings from a FEN string using the Lichess openings database.
+* **Input:** `{ fen: string }`
+
+### 8. **`find_opening_by_name`**
+
+* **Description:** Searches for openings by name in the Lichess openings database.
+* **Input:** `{ name: string }`
+
+---
+
+## Use Cases
+
+* Enhance chess reasoning capabilities of LLM-powered agents.
+* Provide structured chess insights for educational tools and interactive chess applications.
+* Improve accuracy of chess-related interactions by providing engine-backed evaluations.
+
+---
+
+Enjoy building smarter, chess-aware applications with the Chess MCP Server!