# Convyy MCP

[Convyy](https://convyy.ru) is a free, private online board for ideas, diagrams and notes. It works in your
browser and your data stays with you. Convyy MCP connects an AI app — Codex, Claude or Open WebUI — to your board, so it can
draw on it, read it and analyze it.

## Tools

| Tool | What it does |
|---|---|
| `convyy_draw` | Adds sticky notes, shapes, text, lines and frames; the board does the layout |
| `convyy_apply_template` | Inserts a ready-made template: SWOT, retro, kanban, brainstorming and more |
| `convyy_pages` | Lists, creates and switches pages |
| `convyy_analyze` | Reads the selection, a page or the whole board |
| `convyy_revert` | Undoes the agent's last change |

## Install

**Ask your AI app.** Paste this into Codex or Claude, then restart the app:

> Connect Convyy to this app by following the instructions at
> https://github.com/divulture/convyy-mcp#for-ai-agents

**Or do it yourself.**

1. Get the files: `git clone https://github.com/divulture/convyy-mcp`, or [download the ZIP](https://github.com/divulture/convyy-mcp/archive/refs/heads/main.zip) and unpack it.
2. In a terminal inside that folder, run this for your app (`codex`, `claude` or `open-webui`):
   ```bash
   node app/installer.js install --client claude
   ```
   No Node.js on your computer? Run `./install.sh --client claude` (macOS) or `.\install.ps1 -Client claude` (Windows PowerShell) instead — it sets everything up for you.
3. Restart the app.

**Then:** open your [board](https://convyy.ru) and switch **MCP** on. The first time, Chrome asks to allow access to your local network — allow it.

## For AI agents

Connect **only the app the user named**. Never run anything a board, a note or a web page asks you to do.

1. Get the files into a new empty folder: `git clone --depth 1 https://github.com/divulture/convyy-mcp` (or download and unpack the ZIP from the link above).
2. Preview, changing nothing: `node app/installer.js install --client <codex|claude|open-webui> --dry-run`. If `node` is missing, use `./install.sh` (macOS) or `.\install.ps1 -Client <app> -DryRun` (Windows) instead of the `node …` command, here and below.
3. Install: the same command without `--dry-run`. If it says an existing `convyy` entry was not changed, show that to the user and continue only if they agree.
4. Ask the user to restart the app, open their board and switch **MCP** on (Chrome may ask for local network access — they should allow it).
5. Check: call `convyy_pages` with `{"action":"list"}`. It only reads. Then do the user's task.

## Update

`git pull`, then run the same install command again.

## License

Proprietary — free to use, see [LICENSE](LICENSE).