scribe — MCP-сервер для Claude Code: документация по коду
Генерирует markdown-документацию для файлов проекта прямо в чате агента. Один файл за раз или пачкой до 20 штук.
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Что делает 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.
Какие задачи решает
- описать незнакомый модуль перед правкой
- собрать markdown-справку по пачке файлов за один заход
- восстановить документацию в проекте, где её не вели
- подготовить описание API для нового разработчика
- получить черновик README по исходникам
Примеры запросов агенту
- Задокументируй файл
auth.jsчерез scribe - Прогони
generate_docs_batchпо всем файлам вsrc/api - Сделай markdown-описание для
parser.pyс контекстом: это парсер логов
Как установить scribe
Командой платформы
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 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Вместо <…> подставьте свои значения
Файл настроек
{
"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>"
}
}
}
}Вместо <…> подставьте свои значения
Файл настроек
{
"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 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Вместо <…> подставьте свои значения
По шагам, с командами для каждой платформы: Как подключить MCP-сервер: Claude Code, Codex, Cursor, VS Code, Gemini CLI и другие
Вопросы о scribe
Как установить scribe в Claude Code?
Одной командой: claude mcp add scribe -e WRITULOS_API_KEY=<WRITULOS_API_KEY> -- npx -y writulos-mcp. Ключ подставьте свой.
Что делает scribe?
Генерирует markdown-документацию по исходному коду. Работает через два инструмента: для одного файла и для пачки до 20 файлов.
Что нужно для работы scribe?
Node.js 18+ и ключ Writulos Scribe из личного кабинета. Без ключа сервер запустится, но вызовы инструментов будут возвращать подсказку, где его получить.
