docs(readme): document AI agent chat and add screenshot
The built-in AI agent chat over wiki content is fully implemented (server module, ~40 tools, RAG search, provider settings, external MCP), so showcase it in both READMEs: - list AI agent chat among the from-scratch community replacements - add a "What's different" table row and a dedicated feature section - move AI chat from the "In progress" roadmap bucket to "Done" - add it to the Features list - add docs/screenshots/ai-chat.png and show it in the Screenshots section Updated in sync in README.md and README.ru.md.
This commit is contained in:
31
README.md
31
README.md
@@ -21,8 +21,9 @@ The goal of the fork is a **100% open, AGPL-only build with no Enterprise-Editio
|
||||
`apps/server/src/ee` submodule, the `apps/client/src/ee` directory (201 files) and the
|
||||
`packages/ee` package are gone. There is no license gating: every feature is available to everyone.
|
||||
- **Replacements are written from scratch.** Features that previously lived behind the enterprise
|
||||
license (e.g. comment resolution, the `/mcp` server) were re-implemented from scratch on top of the
|
||||
community codebase. No EE code is reused, and there is no entitlement/feature-flag wall.
|
||||
license (e.g. comment resolution, the AI agent chat, the `/mcp` server) were re-implemented from
|
||||
scratch on top of the community codebase. No EE code is reused, and there is no
|
||||
entitlement/feature-flag wall.
|
||||
- **No upsell.** There are no "buy a license" / "upgrade to Enterprise" banners, trial nags, or
|
||||
locked-feature placeholders anywhere in the UI.
|
||||
- Authentication is plain email + password (no SSO/LDAP/cloud/billing flows).
|
||||
@@ -34,6 +35,7 @@ The goal of the fork is a **100% open, AGPL-only build with no Enterprise-Editio
|
||||
| **EE code removed** | Stripped all client and server Enterprise-Edition code; ships as a clean community/AGPL build with no license checks. |
|
||||
| **Comment resolution** | Re-implemented from scratch as a community feature (resolve / re-open with Open/Resolved tabs). No EE code reused, available to anyone who can comment. |
|
||||
| **Embedded MCP server** | A community MCP server (`@docmost/mcp`, 38 tools) is served over HTTP at `/mcp` — no enterprise license required. Replaces the removed license-gated EE MCP. |
|
||||
| **AI agent chat** | Built-in AI agent chat over your wiki, written from scratch as a community feature — no enterprise license. The agent reads and edits pages on your behalf (scoped to your permissions), with full-text + vector (RAG) search and optional web access via external MCP servers. |
|
||||
| **Rebranding** | App logo / name changed from *Docmost* to *Gitmost*. |
|
||||
| **Compact page tree** | Default page-tree indentation reduced from 16px to 8px per nesting level. |
|
||||
| **CI / images** | Release CI publishes container images to GHCR (`ghcr.io/vvzvlad/gitmost`) using the built-in `GITHUB_TOKEN` instead of Docker Hub. |
|
||||
@@ -69,16 +71,37 @@ it doesn't make it more capable, you simply don't have to install and run a sepa
|
||||
process. An admin flips one toggle in **Workspace settings → AI & MCP** and any MCP client
|
||||
points at `${APP_URL}/mcp`.
|
||||
|
||||
### AI agent chat
|
||||
|
||||
Gitmost ships a **built-in AI agent chat** over your wiki — written from scratch as a
|
||||
community feature, with no enterprise license. Open it from the page header; the agent can
|
||||
**read and edit** your workspace on your behalf:
|
||||
|
||||
- **Full read + write toolset (~40 tools).** Search and read pages, make surgical per-block
|
||||
and table edits, create / rename / move pages, diff and restore page history, and create /
|
||||
resolve comments — every action runs under *your* permissions (Docmost CASL), so the agent
|
||||
can never see or change anything you couldn't.
|
||||
- **Safe by design.** The agent is given only **reversible** operations (page history +
|
||||
trash); permanent deletion is never exposed. Agent edits are marked in page history with an
|
||||
"AI agent" badge linking back to the chat.
|
||||
- **Search over your content.** Full-text search plus optional vector (RAG) semantic search
|
||||
across pages.
|
||||
- **Web access via external MCP.** Admins can connect external MCP servers (e.g. Tavily) to
|
||||
give the agent web search / internet access.
|
||||
- **Bring your own model.** Configure the provider (OpenAI, Gemini or Ollama), model and API
|
||||
key in **Workspace settings → AI & MCP → AI / Models**. The key is encrypted and never
|
||||
leaves the server.
|
||||
|
||||
## Roadmap
|
||||
|
||||
### Done
|
||||
|
||||
- ✅ **MCP server** — embedded community MCP server served at `/mcp`.
|
||||
- ✅ **macOS app** — native macOS app ([docmost-app](https://github.com/vvzvlad/docmost-app)) that embeds the UI with multi-server tabs.
|
||||
- ✅ **AI chat** — built-in AI agent chat over your wiki content (read + write, RAG search, configurable provider, optional web access via external MCP).
|
||||
|
||||
### In progress
|
||||
|
||||
- 🚧 **AI chat** — built-in AI agent chat over your wiki content.
|
||||
- 🚧 **Git synchronization** — two-way sync of pages with a Git repository.
|
||||
|
||||
### Planned
|
||||
@@ -111,10 +134,12 @@ Gitmost follows the upstream Docmost setup. See the Docmost
|
||||
- Embeds (Airtable, Loom, Miro and more)
|
||||
- Translations (10+ languages)
|
||||
- Embedded MCP server (`/mcp`)
|
||||
- AI agent chat over your wiki (read + write, RAG search, external MCP / web access)
|
||||
|
||||
### Screenshots
|
||||
|
||||
<p align="center">
|
||||
<img alt="AI agent chat" src="docs/screenshots/ai-chat.png" width="70%">
|
||||
<img alt="home" src="https://docmost.com/screenshots/home.png" width="70%">
|
||||
<img alt="editor" src="https://docmost.com/screenshots/editor.png" width="70%">
|
||||
</p>
|
||||
|
||||
31
README.ru.md
31
README.ru.md
@@ -21,8 +21,8 @@
|
||||
сабмодуль `apps/server/src/ee`, каталог `apps/client/src/ee` (201 файл) и пакет
|
||||
`packages/ee`. Никаких лицензионных ограничений: все функции доступны всем.
|
||||
- **Замены написаны с нуля.** Функции, которые раньше были скрыты за enterprise-лицензией
|
||||
(например, резолв комментариев, сервер `/mcp`), переписаны с нуля поверх community-кодовой
|
||||
базы. EE-код не переиспользуется, нет проверок entitlement и feature-флагов.
|
||||
(например, резолв комментариев, чат с AI-агентом, сервер `/mcp`), переписаны с нуля поверх
|
||||
community-кодовой базы. EE-код не переиспользуется, нет проверок entitlement и feature-флагов.
|
||||
- **Никакого навязывания.** В интерфейсе нигде нет плашек «купите лицензию» / «перейдите на
|
||||
Enterprise», напоминаний о триале и заглушек на месте заблокированных функций.
|
||||
- Аутентификация — обычная пара email + пароль (без SSO/LDAP/облака/биллинга).
|
||||
@@ -34,6 +34,7 @@
|
||||
| **Удалён EE-код** | Вырезан весь код Enterprise-редакции на клиенте и сервере; это чистая community/AGPL-сборка без лицензионных проверок. |
|
||||
| **Резолв комментариев** | Переписан с нуля как community-функция (резолв / переоткрытие с вкладками «Открытые» / «Решённые»). EE-код не используется, доступно любому, кто может комментировать. |
|
||||
| **Встроенный MCP-сервер** | Community MCP-сервер (`@docmost/mcp`, 38 инструментов) отдаётся по HTTP на `/mcp` — без enterprise-лицензии. Заменяет удалённый лицензируемый EE MCP. |
|
||||
| **Чат с AI-агентом** | Встроенный чат с AI-агентом по содержимому вики, написанный с нуля как community-функция — без enterprise-лицензии. Агент читает и редактирует страницы от вашего имени (в рамках ваших прав), с полнотекстовым + векторным (RAG) поиском и опциональным доступом в интернет через внешние MCP-серверы. |
|
||||
| **Ребрендинг** | Логотип / название приложения изменены с *Docmost* на *Gitmost*. |
|
||||
| **Компактное дерево страниц** | Отступ дерева страниц по умолчанию уменьшен с 16px до 8px на уровень вложенности. |
|
||||
| **CI / образы** | Release-CI публикует контейнерные образы в GHCR (`ghcr.io/vvzvlad/gitmost`) через встроенный `GITHUB_TOKEN` вместо Docker Hub. |
|
||||
@@ -70,16 +71,38 @@ real-time-коллаборации Docmost, поэтому запись нико
|
||||
процесс. Админ включает его одним переключателем в **Настройки воркспейса → AI & MCP**, а
|
||||
любой MCP-клиент указывает на `${APP_URL}/mcp`.
|
||||
|
||||
### Чат с AI-агентом
|
||||
|
||||
В Gitmost есть **встроенный чат с AI-агентом** по содержимому вики — написанный с нуля
|
||||
как community-функция, без enterprise-лицензии. Открывается из шапки страницы; агент умеет
|
||||
**читать и редактировать** ваш воркспейс от вашего имени:
|
||||
|
||||
- **Полный набор инструментов чтения + записи (~40 штук).** Поиск и чтение страниц,
|
||||
точечные правки по блокам и в таблицах, создание / переименование / перемещение страниц,
|
||||
дифф и восстановление версий, создание / резолв комментариев — каждое действие
|
||||
выполняется под *вашими* правами (Docmost CASL), поэтому агент не видит и не меняет
|
||||
ничего, чего не могли бы вы сами.
|
||||
- **Безопасность по умолчанию.** Агенту доступны только **обратимые** операции (история
|
||||
версий + корзина); перманентное удаление не экспонируется. Правки агента помечаются в
|
||||
истории версий бейджем «AI-агент» со ссылкой на чат.
|
||||
- **Поиск по вашему контенту.** Полнотекстовый поиск плюс опциональный векторный (RAG)
|
||||
семантический поиск по страницам.
|
||||
- **Доступ в интернет через внешние MCP.** Админ может подключить внешние MCP-серверы
|
||||
(например, Tavily), чтобы дать агенту веб-поиск / доступ в интернет.
|
||||
- **Своя модель.** Провайдер (OpenAI, Gemini или Ollama), модель и API-ключ настраиваются
|
||||
в **Настройки воркспейса → AI & MCP → AI / Модели**. Ключ шифруется и никогда не покидает
|
||||
сервер.
|
||||
|
||||
## Дорожная карта
|
||||
|
||||
### Готово
|
||||
|
||||
- ✅ **MCP-сервер** — встроенный community MCP-сервер на `/mcp`.
|
||||
- ✅ **Приложение для macOS** — нативное приложение для macOS ([docmost-app](https://github.com/vvzvlad/docmost-app)), встраивающее UI с вкладками для нескольких серверов.
|
||||
- ✅ **AI-чат** — встроенный чат с AI-агентом по содержимому вики (чтение + запись, RAG-поиск, настраиваемый провайдер, опциональный доступ в интернет через внешние MCP).
|
||||
|
||||
### В процессе
|
||||
|
||||
- 🚧 **AI-чат** — встроенный чат с AI-агентом по содержимому вики.
|
||||
- 🚧 **Синхронизация с Git** — двусторонняя синхронизация страниц с Git-репозиторием.
|
||||
|
||||
### В планах
|
||||
@@ -112,10 +135,12 @@ Gitmost повторяет процесс установки upstream-Docmost.
|
||||
- Встраивания (Airtable, Loom, Miro и другие)
|
||||
- Переводы (10+ языков)
|
||||
- Встроенный MCP-сервер (`/mcp`)
|
||||
- Чат с AI-агентом по вики (чтение + запись, RAG-поиск, внешние MCP / доступ в интернет)
|
||||
|
||||
### Скриншоты
|
||||
|
||||
<p align="center">
|
||||
<img alt="Чат с AI-агентом" src="docs/screenshots/ai-chat.png" width="70%">
|
||||
<img alt="home" src="https://docmost.com/screenshots/home.png" width="70%">
|
||||
<img alt="editor" src="https://docmost.com/screenshots/editor.png" width="70%">
|
||||
</p>
|
||||
|
||||
BIN
docs/screenshots/ai-chat.png
Normal file
BIN
docs/screenshots/ai-chat.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 726 KiB |
Reference in New Issue
Block a user