From 444ea9fbea9075a63c67a82dc2fd45baa4f5c315 Mon Sep 17 00:00:00 2001 From: yichuan520030910320 Date: Fri, 15 Aug 2025 15:05:51 -0700 Subject: [PATCH] docs: update READMEs (MCP docs + conclusion polish)\n\n- Polish conclusion in packages/leann-mcp/README.md\n- Sync root README wording and links\n\nNo code changes. --- README.md | 11 ++++++----- packages/leann-mcp/README.md | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d37f79e..91b6b5f 100755 --- a/README.md +++ b/README.md @@ -426,21 +426,21 @@ Once the index is built, you can ask questions like: **The future of code assistance is here.** Transform your development workflow with LEANN's native MCP integration for Claude Code. Index your entire codebase and get intelligent code assistance directly in your IDE. **Key features:** -- 🔍 **Semantic code search** across your entire project +- 🔍 **Semantic code search** across your entire project, fully local index and lightweight - 📚 **Context-aware assistance** for debugging and development - 🚀 **Zero-config setup** with automatic language detection ```bash # Install LEANN globally for MCP integration -uv tool install leann-core - +uv tool install leann-core --with leann +claude mcp add --scope user leann-server -- leann_mcp # Setup is automatic - just start using Claude Code! ``` Try our fully agentic pipeline with auto query rewriting, semantic search planning, and more: ![LEANN MCP Integration](assets/mcp_leann.png) -**Ready to supercharge your coding?** [Complete Setup Guide →](packages/leann-mcp/README.md) +**🔥 Ready to supercharge your coding?** [Complete Setup Guide →](packages/leann-mcp/README.md) ## 🖥️ Command Line Interface @@ -457,7 +457,8 @@ leann --help **To make it globally available:** ```bash # Install the LEANN CLI globally using uv tool -uv tool install leann-core +uv tool install leann-core --with leann + # Now you can use leann from anywhere without activating venv leann --help diff --git a/packages/leann-mcp/README.md b/packages/leann-mcp/README.md index f19bb85..cf783d4 100644 --- a/packages/leann-mcp/README.md +++ b/packages/leann-mcp/README.md @@ -92,7 +92,7 @@ leann build docs-and-configs --docs $(git ls-files "*.md" "*.yml" "*.yaml" "*.js ``` -**Try this in Claude Code:** +## **Try this in Claude Code:** ``` Help me understand this codebase. List available indexes and search for authentication patterns. ```