You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.en.md
+72-1Lines changed: 72 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,6 +88,14 @@ More examples at - https://t.me/blockmineJs
88
88
<em>Interactive panel for working with WebSocket API</em>
89
89
</p>
90
90
91
+
### 🤖 MCP Server (for AI assistants)
92
+
-**Built-in**[Model Context Protocol](https://modelcontextprotocol.io/) endpoint at `POST /api/mcp`
93
+
-**25 tools**: bot management, plugins, users/groups/permissions, plugin file authoring straight on the host
94
+
-**Auth** via Panel API Key (`pk_*`) — same keys used by the WebSocket API
95
+
-**Connect from anywhere** — Claude Desktop, Cursor, Cline, Claude Code, and any MCP-compatible client
96
+
-**`plugin-author` prompt** — full plugin-development guide served by the MCP itself, AI clients fetch it with a single `prompts/get`
97
+
-**npm package [`blockmine-mcp`](https://www.npmjs.com/package/blockmine-mcp)** — thin stdio↔HTTP bridge for clients without native HTTP MCP support
98
+
91
99
---
92
100
93
101
## ✨ Quick Start with `npx`
@@ -302,9 +310,72 @@ Automate bot actions on schedule:
302
310
303
311
---
304
312
313
+
## 🤖 MCP — drive BlockMine with AI assistants
314
+
315
+
BlockMine ships a **built-in MCP server** (Model Context Protocol) on `POST /api/mcp`. Any MCP-compatible AI client — Claude Desktop, Cursor, Cline, Claude Code — can manage your bots, author plugins, read settings and logs through a normal chat with the AI.
The MCP endpoint comes up together with the panel. If BlockMine runs on a VPS, just use its public URL instead of `localhost:3001`. Auth is per-request via `Authorization: Bearer pk_*` — same keys as the WebSocket API.
371
+
372
+
More about the npm package: [`blockmineJS/blockmine-mcp`](https://github.com/blockmineJS/blockmine-mcp).
373
+
374
+
---
375
+
305
376
## 🧑💻 For Developers and Contributors
306
377
307
-
> **🤖 For AI Agents:** If you are an AI agent that wants to create plugins for BlockMine, read the file [backend/src/ai/plugin-assistant-system-prompt.md](D:\webstormproject\blockmine\backend\src\ai\plugin-assistant-system-prompt.md) for plugin development instructions.
378
+
> **🤖 For AI Agents:** If you are an AI agent connected via MCP, you already have the `plugin-author` prompt (call `prompts/get` with that name). Without MCP, see [backend/src/ai/plugin-assistant-system-prompt.md](./backend/src/ai/plugin-assistant-system-prompt.md).
308
379
309
380
If you want to contribute to the project or run it in development mode.
Copy file name to clipboardExpand all lines: README.md
+72-1Lines changed: 72 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,6 +90,14 @@
90
90
<em>Интерактивная панель для работы с WebSocket API</em>
91
91
</p>
92
92
93
+
### 🤖 MCP Server (для AI-ассистентов)
94
+
-**Встроенный**[Model Context Protocol](https://modelcontextprotocol.io/) endpoint на `POST /api/mcp`
95
+
-**25 tools**: управление ботами, плагины, пользователи/группы/права, чтение/запись файлов плагина прямо на хосте
96
+
-**Авторизация** через Panel API Key (`pk_*`) — те же ключи, что и для WebSocket API
97
+
-**Подключение из любого хоста** — Claude Desktop, Cursor, Cline, Claude Code и т.д.
98
+
-**`plugin-author` prompt** — полное руководство по разработке плагинов прямо в MCP, AI получает его одним вызовом `prompts/get`
99
+
-**npm-пакет [`blockmine-mcp`](https://www.npmjs.com/package/blockmine-mcp)** — тонкий stdio↔HTTP-мост для клиентов которые не умеют HTTP MCP
100
+
93
101
---
94
102
95
103
## ✨ Быстрый старт с `npx`
@@ -305,9 +313,72 @@ bot.registerCommand({
305
313
306
314
---
307
315
316
+
## 🤖 MCP — управление через AI-ассистентов
317
+
318
+
BlockMine выставляет **встроенный MCP-сервер** (Model Context Protocol) на `POST /api/mcp`. Это значит, что любой MCP-совместимый AI-клиент — Claude Desktop, Cursor, Cline, Claude Code — может управлять твоими ботами, создавать плагины, читать настройки и логи через обычный диалог с AI.
MCP endpoint поднимается вместе с самой панелью. Если BlockMine крутится на VPS — подставь публичный URL вместо `localhost:3001`. Авторизация per-request через `Authorization: Bearer pk_*` — те же ключи, что и для WebSocket API.
374
+
375
+
Подробнее об npm-пакете: [`blockmineJS/blockmine-mcp`](https://github.com/blockmineJS/blockmine-mcp).
376
+
377
+
---
378
+
308
379
## 🧑💻 Для разработчиков и контрибьюторов
309
380
310
-
> **🤖 Для AI агентов:** Если вы AI агент, который хочет создавать плагины для BlockMine, прочитайте файл [backend/src/ai/plugin-assistant-system-prompt.md](D:\webstormproject\blockmine\backend\src\ai\plugin-assistant-system-prompt.md) для получения инструкций по разработке плагинов.
381
+
> **🤖 Для AI агентов:** Если вы AI агент через MCP, у вас уже есть промпт `plugin-author` (вызовите `prompts/get` с этим именем). Если нет MCP — см. [backend/src/ai/plugin-assistant-system-prompt.md](./backend/src/ai/plugin-assistant-system-prompt.md).
311
382
312
383
Если вы хотите внести свой вклад в проект или запустить его в режиме разработки.
0 commit comments