From 550d6eb3f2b0c6f6a9dc3c850bf718dfe2f54278 Mon Sep 17 00:00:00 2001
From: Flash <flash@openclaw.ai>
Date: Thu, 9 Apr 2026 10:59:34 +0000
Subject: [PATCH] docs: add README with installation and usage instructions

---
 README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7721117
--- /dev/null
+++ b/README.md
@@ -0,0 +1,80 @@
+# Planka MCP Server
+
+A Model Context Protocol (MCP) server for interacting with Planka, a kanban-style project management tool.
+
+## Features
+
+- **List Projects**: Get a list of all accessible projects.
+- **List Boards**: List boards within a project.
+- **List Columns**: List columns (lists) on a board.
+- **List Cards**: List cards in a column or on a board.
+- **Move Card**: Move a card to a different column or position.
+- **Add Comment**: Add a comment to a card.
+- **List Comments**: Retrieve comments for a card.
+
+## Installation
+
+### Prerequisites
+
+- Python 3.10+
+- A Planka instance and a personal access token.
+
+### Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://git.danilkolesnikov.ru/Flash/planka-mcp.git
+   cd planka-mcp
+   ```
+
+2. Create a virtual environment and install dependencies:
+   ```bash
+   python3 -m venv venv
+   source venv/bin/activate
+   pip install -r requirements.txt
+   ```
+
+3. Configure environment variables:
+   Create a `.env` file or export the following:
+   ```bash
+   export PLANKA_URL="https://your-planka-instance.com"
+   export PLANKA_TOKEN="your-access-token"
+   ```
+
+## Usage
+
+You can run the server directly or via an MCP client (like OpenClaw or Claude Desktop).
+
+### Command Line
+
+```bash
+python3 server.py list_projects
+```
+
+### MCP Configuration (OpenClaw)
+
+Add the following to your `openclaw.json` or equivalent configuration:
+
+```json
+{
+  "planka": {
+    "command": "/path/to/venv/bin/python3",
+    "args": ["/path/to/server.py"],
+    "env": {
+      "PLANKA_URL": "...",
+      "PLANKA_TOKEN": "..."
+    }
+  }
+}
+```
+
+## Development
+
+Run tests:
+```bash
+pytest test_server.py test_planka_logic.py
+```
+
+## License
+
+MIT