Командная строка¶
Пакет ставит одну команду с двумя подкомандами. serve запускает клиент, check — вы сами.
$ worklog-mcp --help
Usage: worklog-mcp [OPTIONS] COMMAND [ARGS]...
Append what you did to the checklist of the newest file in a directory.
Commands:
serve Run the MCP server on stdio. This is the command an MCP client starts.
check Report which log file would be written to, and how many items it holds.
Обе подкоманды принимают --dir и --pattern, см. Настройку.
serve¶
Говорит по протоколу Model Context Protocol на стандартных вводе и выводе, поэтому запуск в терминале выглядит как зависание — это работа клиента, а не ваша. Команда завершается, когда клиент закрывает соединение.
Каталог намеренно не проверяется при старте. Сервер, отказавшийся стартовать, выглядел бы в клиенте как оборванное соединение без инструментов и без объяснений; вместо этого он стартует, отдаёт оба инструмента, и каждый вызов возвращает no_dir, пока каталога нет. Это же переживает каталог на диске, который монтируется после входа в систему.
check¶
Отвечает на один вопрос: в какой файл писал бы append и сколько пунктов уже есть в его чек-листе. Это проба, а не просмотр: сами пункты не печатаются никогда.
Коды возврата¶
| Код | Что значит | Что делать |
|---|---|---|
0 |
Лог-файл с чек-листом найден | Ничего |
1 |
Файл не является корректным UTF-8 | Починить кодировку файла |
2 |
Каталог не задан или не существует | Проверить --dir / WORKLOG_DIR; тот же код у неверного паттерна и неверных аргументов |
3 |
В каталоге нет подходящего файла | Создать сегодняшний лог или ослабить --pattern |
4 |
В файле пока нет чек-листа | Ничего — следующий append его заведёт |
Код 3 — тот, что означает заметки лежат не там, где сервер их ждёт, ради него check и существует: он отличает «сервер настроен неверно» от «сегодняшний файл ещё не начат». Код 4 — вообще не ошибка: check сообщает, что чек-листа в файле нет, а append его заведёт.
Отказы печатаются в стандартный поток ошибок с префиксом worklog-mcp: и никогда не содержат пути к каталогу.