docs: add README#160
Merged
Merged
Conversation
![lexi-chief-of-staff[bot]](https://avatars.githubusercontent.com/in/3490641?s=60&v=4){kind=small}
There was a problem hiding this comment.
Ship it.
- README now matches the live MCP server (
routes/ai.php,KnowledgeServer) and the eight tools. - Config keys and service story updated to
.env.exampleandconfig/search.php. - Commands section expanded to cover
daemon:install,reindex:all, code vectorization, and thethe-shit/vectorstack. - No factual drift; every signature and key was cross-checked against source.
There was a problem hiding this comment.
Ship it.
- All 8 MCP tools listed match the actual registration in routes/ai.php and KnowledgeServer.php
- Config keys now align with .env.example and config/search.php
- Services section correctly reflects docker-compose.yml (Qdrant only) and external embedding server requirement
- New commands (daemon:install, reindex:all, vectorize-code) are present in the source tree
- Version numbers, stack, and testing instructions are accurate
No blocking issues found. Ready to merge.
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
1 participant
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.
Refreshes the README to match the current codebase after recent feature work (MCP tools,
the-shit/vectorconnector, code vectorization, daemon/reindex commands).What changed
routes/ai.php→KnowledgeServer), including all 8 tools (recall,remember,correct,context,stats,search-code,file-outline,symbol-lookup) and how to start it for an AI client — previously absent..env.exampleandconfig/search.php:QDRANT_EMBEDDING_SERVER(wasEMBEDDING_SERVER_URL), splitOLLAMA_HOST/OLLAMA_PORT, addedQDRANT_ENABLED,EMBEDDING_PROVIDER,EMBEDDING_DIMENSION, hybrid search, and the~/.knowledge/config.jsonoverride.make up/docker-compose.ymlstarts Qdrant only (ports 6333/6334); the embedding server is external viaQDRANT_EMBEDDING_SERVER.daemon:install,reindex:all,vectorize-code.the-shit/vectorconnector; corrected the install path (standalone CLI,git clone+composer install, optional Box PHAR).Every command signature, config key, and code reference was verified against source.