# scribe

Генерирует markdown-документацию для файлов проекта прямо в чате агента. Один файл за раз или пачкой до 20 штук.

- MCP-сервер · `type=mcp` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline, Zed, Gemini CLI
- Автор: writulos
- Лицензия: MIT · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/writulos/writulos-mcp
- Обновлён: 2026-10-20
- HTML: https://affpapa.org/nevibecode/mcp/scribe

## Что делает

scribe — MCP-сервер от writulos, который превращает исходники в markdown-описания. Внутри два инструмента: `generate_docs` берёт один файл, `generate_docs_batch` принимает массив до 20 файлов за один запрос. На вход идут код, имя файла и необязательный контекст, на выходе — готовый текст в чате.

Ставится без сборки: сервер запускается через `npx writulos-mcp`. В Cursor прописывается в `.cursor/mcp.json`, в Claude, Codex и Gemini CLI добавляется командой `claude mcp add`, `codex mcp add` или `gemini mcp add`. Нужен ключ `WRITULOS_API_KEY` — без него сервер стартует, но каждый вызов инструмента отвечает, где ключ взять. Ещё понадобится Node.js 18+.

Каждый задокументированный файл списывает одну генерацию из месячного лимита тарифа Writulos — того же, что расходуют дашборд и GitHub Action. Когда лимит кончился, инструменты сообщают об этом и называют дату сброса. Сам сервер пишет только лог прогонов в `docs/writulos.log`, путь меняется через `WRITULOS_OUTPUT_DIR`.

## Требования
- Нужно: Node.js (команды через npx)
- Переменные окружения: `WRITULOS_API_KEY`, `WRITULOS_OUTPUT_DIR`, `WRITULOS_PROJECT_ROOT`, `WRITULOS_API_URL` — это ключи и токены: значения спроси у человека, в репозиторий и общие файлы не записывай.

## Установка

### Claude Code (родная платформа)

**Командой платформы**
```bash
claude mcp add --env WRITULOS_API_KEY=<WRITULOS_API_KEY> --env WRITULOS_OUTPUT_DIR=<WRITULOS_OUTPUT_DIR> --env WRITULOS_PROJECT_ROOT=<WRITULOS_PROJECT_ROOT> --env WRITULOS_API_URL=<WRITULOS_API_URL> --transport stdio scribe -- npx -y writulos-mcp
```
Вместо <…> подставьте свои значения

### Codex

**Командой платформы**
```bash
codex mcp add scribe --env WRITULOS_API_KEY=<WRITULOS_API_KEY> --env WRITULOS_OUTPUT_DIR=<WRITULOS_OUTPUT_DIR> --env WRITULOS_PROJECT_ROOT=<WRITULOS_PROJECT_ROOT> --env WRITULOS_API_URL=<WRITULOS_API_URL> -- npx -y writulos-mcp
```
Вместо <…> подставьте свои значения

### Cursor

**Файл настроек**
Файл `.cursor/mcp.json`:
```json
{
    "mcpServers": {
        "scribe": {
            "command": "npx",
            "args": [
                "-y",
                "writulos-mcp"
            ],
            "env": {
                "WRITULOS_API_KEY": "<WRITULOS_API_KEY>",
                "WRITULOS_OUTPUT_DIR": "<WRITULOS_OUTPUT_DIR>",
                "WRITULOS_PROJECT_ROOT": "<WRITULOS_PROJECT_ROOT>",
                "WRITULOS_API_URL": "<WRITULOS_API_URL>"
            }
        }
    }
}
```
Вместо <…> подставьте свои значения

### GitHub Copilot

**Файл настроек**
Файл `.vscode/mcp.json`:
```json
{
    "servers": {
        "scribe": {
            "type": "stdio",
            "command": "npx",
            "args": [
                "-y",
                "writulos-mcp"
            ],
            "env": {
                "WRITULOS_API_KEY": "<WRITULOS_API_KEY>",
                "WRITULOS_OUTPUT_DIR": "<WRITULOS_OUTPUT_DIR>",
                "WRITULOS_PROJECT_ROOT": "<WRITULOS_PROJECT_ROOT>",
                "WRITULOS_API_URL": "<WRITULOS_API_URL>"
            }
        }
    }
}
```
Вместо <…> подставьте свои значения

### Gemini CLI

**Командой платформы**
```bash
gemini mcp add -e WRITULOS_API_KEY=<WRITULOS_API_KEY> -e WRITULOS_OUTPUT_DIR=<WRITULOS_OUTPUT_DIR> -e WRITULOS_PROJECT_ROOT=<WRITULOS_PROJECT_ROOT> -e WRITULOS_API_URL=<WRITULOS_API_URL> scribe npx -y writulos-mcp
```
Вместо <…> подставьте свои значения

## Когда брать
- описать незнакомый модуль перед правкой
- собрать markdown-справку по пачке файлов за один заход
- восстановить документацию в проекте, где её не вели
- подготовить описание API для нового разработчика
- получить черновик README по исходникам

## Примеры запросов агенту
- Задокументируй файл `auth.js` через scribe
- Прогони `generate_docs_batch` по всем файлам в `src/api`
- Сделай markdown-описание для `parser.py` с контекстом: это парсер логов

## Похожие
- [Reactive Resume](https://affpapa.org/nevibecode/mcp/reactive-resume.md) — MCP-сервер · ★ 44908
- [Sui Knowledge Base (kapa.ai)](https://affpapa.org/nevibecode/mcp/sui-knowledge-base-kapaai.md) — MCP-сервер · ★ 7785
- [Claude Code Ultimate Guide](https://affpapa.org/nevibecode/mcp/claude-code-ultimate-guide.md) — MCP-сервер · ★ 6258
- [Zotero MCP](https://affpapa.org/nevibecode/mcp/zotero-mcp.md) — MCP-сервер · ★ 5585
- [RevoGrid DataGrid MCP Pro](https://affpapa.org/nevibecode/mcp/revogrid-datagrid-mcp-pro.md) — MCP-сервер · ★ 3451
- [Claude Code Explorer MCP](https://affpapa.org/nevibecode/mcp/codeaashu-claude-code-explorer-mcp.md) — MCP-сервер · ★ 3412

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md