docs: make install a two-minute path - #7
Merged
Merged
Conversation
The install section led with `pipx install --editable .` and manual `claude mcp add`, which only makes sense if you already cloned the repo — a new user had to work out that a marketplace manifest exists at all. It now opens with the actual short path (pipx from git, key, index, two slash commands) and keeps the flags as reference below. Adds a troubleshooting table for the failures that actually happen: a degraded answer, a WAF 403 that looks like a bad key, missing PySocks behind a proxy, and a stale index. Each row names the cause, because the symptom never does. Also states the cross-engine premise up front — one index shared by Claude Code and Codex is the point of the tool, and the old opening buried it in clause two. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Зачем
Раздел установки начинался с
pipx install --editable .и ручногоclaude mcp add—то есть предполагал, что репозиторий уже склонирован. О том, что в репозитории лежит
marketplace.jsonи плагин ставится двумя слэш-командами, README не сообщал вообще.Что стало
index→ две команды в Claude Code.Явно сказано, что новую сессию надо начать заново (MCP грузится на старте сессии).
scoreв выдаче = семантика работает.degradedв ответе; 403 с HTML-телом от WAF,который выглядит как плохой ключ (он одинаков и без ключа); отсутствие PySocks за прокси;
протухший индекс. В каждой строке названа причина — симптом её не называет никогда.
оставлен для тех, кто регистрировал MCP руками.
это суть инструмента, а раньше она пряталась во втором придаточном.
Проверено: репозиторий публичный (pipx из git сработает),
marketplace.jsonна месте,оба entry point'а (
session-recall,session-recall-mcp) существуют.🤖 Generated with Claude Code