lynkr 3.1.0 → 3.2.0

package/README.md

@@ -13,12 +13,18 @@
 
 > **Production-ready Claude Code proxy server supporting Databricks, OpenRouter, Ollama & Azure. Features MCP integration, prompt caching & 60-80% token optimization savings.**
 
+## 🔖 Keywords
+
+`claude-code` `claude-proxy` `anthropic-api` `databricks-llm` `openrouter-integration` `ollama-local` `llama-cpp` `azure-openai` `azure-anthropic` `mcp-server` `prompt-caching` `token-optimization` `ai-coding-assistant` `llm-proxy` `self-hosted-ai` `git-automation` `code-generation` `developer-tools` `ci-cd-automation` `llm-gateway` `cost-reduction` `multi-provider-llm`
+
+---
+
 ## Table of Contents
 
 1. [Why Lynkr?](#why-lynkr)
 2. [Quick Start (3 minutes)](#quick-start-3-minutes)
 3. [Overview](#overview)
-4. [Supported Models & Providers](#supported-models--providers)
+4. [Supported AI Model Providers](#supported-ai-model-providers-databricks-openrouter-ollama-azure-llamacpp)
 5. [Lynkr vs Native Claude Code](#lynkr-vs-native-claude-code)
 6. [Core Capabilities](#core-capabilities)
    - [Repo Intelligence & Navigation](#repo-intelligence--navigation)
@@ -27,12 +33,12 @@
    - [Execution & Tooling](#execution--tooling)
    - [Workflow & Collaboration](#workflow--collaboration)
    - [UX, Monitoring, and Logs](#ux-monitoring-and-logs)
-7. [Production Hardening Features](#production-hardening-features)
+7. [Production-Ready Features for Enterprise Deployment](#production-ready-features-for-enterprise-deployment)
    - [Reliability & Resilience](#reliability--resilience)
    - [Observability & Monitoring](#observability--monitoring)
    - [Security & Governance](#security--governance)
 8. [Architecture](#architecture)
-9. [Getting Started](#getting-started)
+9. [Getting Started: Installation & Setup Guide](#getting-started-installation--setup-guide)
 10. [Configuration Reference](#configuration-reference)
 11. [Runtime Operations](#runtime-operations)
    - [Launching the Proxy](#launching-the-proxy)
@@ -47,9 +53,10 @@
 12. [Manual Test Matrix](#manual-test-matrix)
 13. [Troubleshooting](#troubleshooting)
 14. [Roadmap & Known Gaps](#roadmap--known-gaps)
-15. [FAQ](#faq)
-16. [References](#references)
-17. [License](#license)
+15. [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
+16. [References & Further Reading](#references--further-reading)
+17. [Community & Adoption](#community--adoption)
+18. [License](#license)
 
 ---
 
@@ -61,13 +68,13 @@ Claude Code CLI is locked to Anthropic's API, limiting your choice of LLM provid
 ### The Solution
 Lynkr is a **production-ready proxy server** that unlocks Claude Code CLI's full potential:
 
-- ✅ **Any LLM Provider** - Databricks, OpenRouter (100+ models), Ollama (local), Azure, OpenAI, llama.cpp
-- ✅ **60-80% Cost Reduction** - Built-in token optimization (5 optimization phases implemented)
-- ✅ **Zero Code Changes** - Drop-in replacement for Anthropic backend
-- ✅ **Local & Offline** - Run Claude Code with Ollama or llama.cpp (no internet required)
-- ✅ **Enterprise Features** - Circuit breakers, load balancing, metrics, K8s-ready health checks
-- ✅ **MCP Integration** - Automatically discover and orchestrate Model Context Protocol servers
-- ✅ **Privacy & Control** - Self-hosted, open-source (Apache 2.0), no vendor lock-in
+- ✅ **Any LLM Provider** - [Databricks, OpenRouter (100+ models), Ollama (local), Azure, OpenAI, llama.cpp](#supported-ai-model-providers-databricks-openrouter-ollama-azure-llamacpp)
+- ✅ **60-80% Cost Reduction** - Built-in [token optimization](#token-optimization-implementation) (5 optimization phases implemented)
+- ✅ **Zero Code Changes** - [Drop-in replacement](#connecting-claude-code-cli) for Anthropic backend
+- ✅ **Local & Offline** - Run Claude Code with [Ollama](#using-ollama-models) or [llama.cpp](#using-llamacpp-with-lynkr) (no internet required)
+- ✅ **Enterprise Features** - [Circuit breakers, load balancing, metrics, K8s-ready health checks](#production-ready-features-for-enterprise-deployment)
+- ✅ **MCP Integration** - Automatically discover and orchestrate [Model Context Protocol servers](#integrating-mcp-servers)
+- ✅ **Privacy & Control** - Self-hosted, open-source ([Apache 2.0](#license)), no vendor lock-in
 
 ### Perfect For
 - 🔧 **Developers** who want flexibility and cost control
@@ -83,8 +90,6 @@ Lynkr is a **production-ready proxy server** that unlocks Claude Code CLI's full
 ### 1️⃣ Install
 ```bash
 npm install -g lynkr
-# or
-brew install lynkr
 ```
 
 ### 2️⃣ Configure Your Provider
@@ -144,6 +149,7 @@ Key highlights:
 - **Workspace awareness** – Local repo indexing, `CLAUDE.md` summaries, language-aware navigation, and Git helpers mirror core Claude Code workflows.
 - **Model Context Protocol (MCP) orchestration** – Automatically discovers MCP manifests, launches JSON-RPC 2.0 servers, and re-exposes their tools inside the proxy.
 - **Prompt caching** – Re-uses repeated prompts to reduce latency and token consumption, matching Claude's own cache semantics.
+- **Smart tool selection** – Intelligently filters tools based on request type (conversational, coding, research), reducing tool tokens by 50-70% for simple queries. Automatically enabled across all providers.
 - **Policy enforcement** – Environment-driven guardrails control Git operations, test requirements, web fetch fallbacks, and sandboxing rules. Input validation and consistent error handling ensure API reliability.
 
 The result is a production-ready, self-hosted alternative that stays close to Anthropic's ergonomics while providing enterprise-grade reliability, observability, and performance.
@@ -154,7 +160,7 @@ Further documentation and usage notes are available on [DeepWiki](https://deepwi
 
 ---
 
-## Supported Models & Providers
+## Supported AI Model Providers (Databricks, OpenRouter, Ollama, Azure, llama.cpp)
 
 Lynkr supports multiple AI model providers, giving you flexibility in choosing the right model for your needs:
 
@@ -164,7 +170,7 @@ Lynkr supports multiple AI model providers, giving you flexibility in choosing t
 |----------|--------------|------------------|----------|
 | **Databricks** (Default) | `MODEL_PROVIDER=databricks` | Claude Sonnet 4.5, Claude Opus 4.5 | Production use, enterprise deployment |
 | **OpenAI** | `MODEL_PROVIDER=openai` | GPT-5, GPT-5.2, GPT-4o, GPT-4o-mini, GPT-4-turbo, o1, o1-mini | Direct OpenAI API access |
-| **Azure OpenAI** | `MODEL_PROVIDER=azure-openai` | GPT-5, GPT-5.2,GPT-4o, GPT-4o-mini, GPT-5, o1, o3 | Azure integration, Microsoft ecosystem |
+| **Azure OpenAI** | `MODEL_PROVIDER=azure-openai` | GPT-5, GPT-5.2,GPT-4o, GPT-4o-mini, GPT-5, o1, o3, Kimi-K2 | Azure integration, Microsoft ecosystem |
 | **Azure Anthropic** | `MODEL_PROVIDER=azure-anthropic` | Claude Sonnet 4.5, Claude Opus 4.5 | Azure-hosted Claude models |
 | **OpenRouter** | `MODEL_PROVIDER=openrouter` | 100+ models (GPT-4o, Claude, Gemini, Llama, etc.) | Model flexibility, cost optimization |
 | **Ollama** (Local) | `MODEL_PROVIDER=ollama` | Llama 3.1, Qwen2.5, Mistral, CodeLlama | Local/offline use, privacy, no API costs |
@@ -193,15 +199,8 @@ Lynkr supports multiple AI model providers, giving you flexibility in choosing t
 
 ### **Azure OpenAI Specific Models**
 
-When using `MODEL_PROVIDER=azure-openai`, you can deploy any of these models:
+When using `MODEL_PROVIDER=azure-openai`, you can deploy any of the models in azure ai foundry:
 
-| Model | Deployment Name | Capabilities | Best For |
-|-------|----------------|--------------|----------|
-| **GPT-4o** | `gpt-4o` | Text, vision, function calling | General-purpose, multimodal tasks |
-| **GPT-4o-mini** | `gpt-4o-mini` | Text, function calling | Fast responses, cost-effective |
-| **GPT-5** | `gpt-5-chat` or custom | Advanced reasoning, longer context | Complex problem-solving |
-| **o1-preview** | `o1-preview` | Deep reasoning, chain of thought | Mathematical, logic problems |
-| **o3-mini** | `o3-mini` | Efficient reasoning | Fast reasoning tasks |
 
 **Note**: Azure OpenAI deployment names are configurable via `AZURE_OPENAI_DEPLOYMENT` environment variable.
 
@@ -267,7 +266,7 @@ FALLBACK_PROVIDER=databricks  # or azure-openai, openrouter, azure-anthropic
 | **Self-Hosted** | ❌ Managed service | ✅ **Full control** (open-source) |
 | **MCP Support** | Limited | ✅ **Full orchestration** with auto-discovery |
 | **Prompt Caching** | Basic | ✅ **Advanced caching** with deduplication |
-| **Token Optimization** | ❌ None | ✅ **5 phases** (history compression, tool truncation, dynamic prompts) |
+| **Token Optimization** | ❌ None | ✅ **6 phases** (smart tool selection, history compression, tool truncation, dynamic prompts) |
 | **Enterprise Features** | Limited | ✅ **Circuit breakers, load shedding, metrics, K8s-ready** |
 | **Privacy** | ☁️ Cloud-dependent | ✅ **Self-hosted** (air-gapped deployments possible) |
 | **Cost Transparency** | Hidden usage | ✅ **Full tracking** (per-request, per-session, Prometheus metrics) |
@@ -305,6 +304,18 @@ FALLBACK_PROVIDER=databricks  # or azure-openai, openrouter, azure-anthropic
 
 ---
 
+## 🚀 Ready to Get Started?
+
+**Reduce your Claude Code costs by 60-80% in under 3 minutes:**
+
+1. ⭐ **[Star this repo](https://github.com/vishalveerareddy123/Lynkr)** to show support and stay updated
+2. 📖 **[Follow the Quick Start Guide](#quick-start-3-minutes)** to install and configure Lynkr
+3. 💬 **[Join our Discord](https://discord.gg/qF7DDxrX)** for real-time community support
+4. 💬 **[Join the Discussion](https://github.com/vishalveerareddy123/Lynkr/discussions)** for questions and ideas
+5. 🐛 **[Report Issues](https://github.com/vishalveerareddy123/Lynkr/issues)** to help improve Lynkr
+
+---
+
 ## Core Capabilities
 
 ### Long-Term Memory System (Titans-Inspired)
@@ -405,9 +416,9 @@ See [MEMORY_SYSTEM.md](MEMORY_SYSTEM.md) for complete documentation and [QUICKST
 
 ---
 
-## Production Hardening Features
+## Production-Ready Features for Enterprise Deployment
 
-Lynkr includes comprehensive production-ready features designed for reliability, observability, and security in enterprise environments. These features add minimal performance overhead while providing robust operational capabilities.
+Lynkr includes comprehensive production-hardened features designed for reliability, observability, and security in enterprise environments. These features add minimal performance overhead while providing robust operational capabilities for mission-critical AI deployments.
 
 ### Reliability & Resilience
 
@@ -575,6 +586,59 @@ Lynkr includes comprehensive production-ready features designed for reliability,
                                 └───────────────────┘
 ```
 
+### Request Flow Diagram
+
+```mermaid
+graph TB
+    A[Claude Code CLI] -->|HTTP POST /v1/messages| B[Lynkr Proxy Server]
+    B --> C{Middleware Stack}
+    C -->|Load Shedding| D{Load OK?}
+    D -->|Yes| E[Request Logging]
+    D -->|No| Z1[503 Service Unavailable]
+    E --> F[Metrics Collection]
+    F --> G[Input Validation]
+    G --> H[Orchestrator]
+
+    H --> I{Check Prompt Cache}
+    I -->|Cache Hit| J[Return Cached Response]
+    I -->|Cache Miss| K{Determine Provider}
+
+    K -->|Simple 0-2 tools| L[Ollama Local]
+    K -->|Moderate 3-14 tools| M[OpenRouter / Azure]
+    K -->|Complex 15+ tools| N[Databricks]
+
+    L --> O[Circuit Breaker Check]
+    M --> O
+    N --> O
+
+    O -->|Closed| P{Provider API}
+    O -->|Open| Z2[Fallback Provider]
+
+    P -->|Databricks| Q1[Databricks API]
+    P -->|OpenRouter| Q2[OpenRouter API]
+    P -->|Ollama| Q3[Ollama Local]
+    P -->|Azure| Q4[Azure Anthropic API]
+
+    Q1 --> R[Response Processing]
+    Q2 --> R
+    Q3 --> R
+    Q4 --> R
+    Z2 --> R
+
+    R --> S[Format Conversion]
+    S --> T[Cache Response]
+    T --> U[Update Metrics]
+    U --> V[Return to Client]
+    J --> V
+
+    style B fill:#4a90e2,stroke:#333,stroke-width:2px,color:#fff
+    style H fill:#7b68ee,stroke:#333,stroke-width:2px,color:#fff
+    style K fill:#f39c12,stroke:#333,stroke-width:2px
+    style P fill:#2ecc71,stroke:#333,stroke-width:2px,color:#fff
+```
+
+**Key Components:**
+
 - **`src/api/router.js`** – Express routes that accept Claude-compatible `/v1/messages` requests.
 - **`src/api/middleware/*`** – Production middleware stack:
   - `load-shedding.js` – Proactive overload protection with resource monitoring
@@ -595,7 +659,7 @@ Lynkr includes comprehensive production-ready features designed for reliability,
 
 ---
 
-## Getting Started
+## Getting Started: Installation & Setup Guide
 
 ### Prerequisites
 
@@ -2113,14 +2177,69 @@ The graceful shutdown and health check endpoints ensure zero-downtime deployment
 
 ---
 
-## References
+## References & Further Reading
 
-Lynkr's design also includes ACE Framework informed by research in agentic AI systems and context engineering:
+### Academic & Technical Resources
 
+**Agentic AI Systems:**
 - **Zhang et al. (2024)**. *Agentic Context Engineering*. arXiv:2510.04618. [arXiv](https://arxiv.org/abs/2510.04618)
 
+**Long-Term Memory & RAG:**
+- **Mohtashami & Jaggi (2023)**. *Landmark Attention: Random-Access Infinite Context Length for Transformers*. [arXiv](https://arxiv.org/abs/2305.16300)
+- **Google DeepMind (2024)**. *Titans: Learning to Memorize at Test Time*. [arXiv](https://arxiv.org/abs/2411.07043)
+
 For BibTeX citations, see [CITATIONS.bib](CITATIONS.bib).
 
+### Official Documentation
+
+- [Claude Code CLI Documentation](https://docs.anthropic.com/en/docs/build-with-claude/claude-for-sheets) - Official Claude Code reference
+- [Model Context Protocol (MCP) Specification](https://spec.modelcontextprotocol.io/) - MCP protocol documentation
+- [Databricks Foundation Models](https://docs.databricks.com/en/machine-learning/foundation-models/index.html) - Databricks LLM documentation
+- [Anthropic API Documentation](https://docs.anthropic.com/en/api/getting-started) - Claude API reference
+
+### Related Projects & Tools
+
+- [Ollama](https://ollama.ai/) - Local LLM runtime for running open-source models
+- [OpenRouter](https://openrouter.ai/) - Multi-provider LLM API gateway (100+ models)
+- [llama.cpp](https://github.com/ggerganov/llama.cpp) - High-performance C++ LLM inference engine
+- [LiteLLM](https://github.com/BerriAI/litellm) - Multi-provider LLM proxy (alternative approach)
+- [Awesome MCP Servers](https://github.com/punkpeye/awesome-mcp-servers) - Curated list of MCP server implementations
+
+---
+
+## Community & Adoption
+
+### Get Involved
+
+**⭐ Star this repository** to show your support and help others discover Lynkr!
+
+[![GitHub stars](https://img.shields.io/github/stars/vishalveerareddy123/Lynkr?style=social)](https://github.com/vishalveerareddy123/Lynkr)
+
+### Support & Resources
+
+- 🐛 **Report Issues:** [GitHub Issues](https://github.com/vishalveerareddy123/Lynkr/issues) - Bug reports and feature requests
+- 💬 **Discussions:** [GitHub Discussions](https://github.com/vishalveerareddy123/Lynkr/discussions) - Questions, ideas, and community help
+- 💬 **Discord Community:** [Join our Discord](https://discord.gg/qF7DDxrX) - Real-time chat and community support
+- 📚 **Documentation:** [DeepWiki](https://deepwiki.com/vishalveerareddy123/Lynkr) - Comprehensive guides and examples
+- 🔧 **Contributing:** [CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute to Lynkr
+
+### Share Lynkr
+
+Help spread the word about Lynkr:
+
+- 🐦 [Share on Twitter](https://twitter.com/intent/tweet?text=Check%20out%20Lynkr%20-%20a%20production-ready%20Claude%20Code%20proxy%20with%20multi-provider%20support%20and%2060-80%25%20token%20savings!&url=https://github.com/vishalveerareddy123/Lynkr&hashtags=AI,ClaudeCode,LLM,OpenSource)
+- 💼 [Share on LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/vishalveerareddy123/Lynkr)
+- 📰 [Share on Hacker News](https://news.ycombinator.com/submitlink?u=https://github.com/vishalveerareddy123/Lynkr&t=Lynkr%20-%20Production-Ready%20Claude%20Code%20Proxy)
+- 📱 [Share on Reddit](https://www.reddit.com/submit?url=https://github.com/vishalveerareddy123/Lynkr&title=Lynkr%20-%20Production-Ready%20Claude%20Code%20Proxy%20with%20Multi-Provider%20Support)
+
+### Why Developers Choose Lynkr
+
+- 💰 **Massive cost savings** - Save 60-80% on token costs with built-in optimization
+- 🔓 **Provider freedom** - Choose from 7+ LLM providers (Databricks, OpenRouter, Ollama, Azure, llama.cpp)
+- 🏠 **Privacy & control** - Self-hosted, open-source, no vendor lock-in
+- 🚀 **Production-ready** - Enterprise features: circuit breakers, metrics, health checks
+- 🛠️ **Active development** - Regular updates, responsive maintainers, growing community
+
 ---
 
 ## License

package/docs/index.md

@@ -4,8 +4,9 @@
 <script defer data-url="https://devhunt.org/tool/lynkr" src="https://cdn.jsdelivr.net/gh/sidiDev/devhunt-banner/indexV0.js"></script>
 
 
-# Lynkr – Claude Code-Compatible Proxy for Databricks 
-#### Lynkr is an open-source Claude Code-compatible proxy that allows the Claude Code CLI to run directly with any LLMs without losing the features offered by Anthropic backend. It supports MCP servers, Git workflows, repo intelligence, workspace tools,  prompt caching for LLM-powered development and many other features.
+# Lynkr - Production-Ready Claude Code Proxy with Multi-Provider Support, MCP Integration & Token Optimization
+
+#### Lynkr is an open-source, production-ready Claude Code proxy that enables the Claude Code CLI to work with any LLM provider (Databricks, OpenRouter, Ollama, Azure, OpenAI, llama.cpp) without losing Anthropic backend features. It features MCP server orchestration, Git workflows, repo intelligence, workspace tools, prompt caching, and 60-80% token optimization for cost-effective LLM-powered development.
 <!--
 SEO Keywords:
 Databricks, Claude Code, Anthropic, Azure Anthropic,
@@ -14,6 +15,9 @@ developer tools, proxy, git automation, AI developer tools,
 prompt caching, Node.js
 -->
 
+## 🔖 Keywords
+
+`claude-code` `claude-proxy` `anthropic-api` `databricks-llm` `openrouter-integration` `ollama-local` `llama-cpp` `azure-openai` `azure-anthropic` `mcp-server` `prompt-caching` `token-optimization` `ai-coding-assistant` `llm-proxy` `self-hosted-ai` `git-automation` `code-generation` `developer-tools` `ci-cd-automation` `llm-gateway` `cost-reduction` `multi-provider-llm`
 
 ---
 
@@ -28,21 +32,21 @@ prompt caching, Node.js
 
 # 🚀 What is Lynkr?
 
-**Lynkr** is an open-source **Claude Code-compatible backend proxy** that lets you run the **Claude Code CLI** and Claude-style tools **directly against Databricks** or **Azure-hosted Anthropic models** instead of the default Anthropic cloud.
+**Lynkr** is an open-source **Claude Code-compatible backend proxy** that lets you run the **Claude Code CLI** and Claude-style tools **directly against [Databricks, Azure, OpenRouter, Ollama, and llama.cpp](#-configuration-guide-for-multi-provider-support-databricks-azure-openrouter-ollama-llamacpp)** instead of the default Anthropic cloud.
 
 It enables full repo-aware LLM workflows:
 
-- code navigation  
-- diff review  
-- Git operations  
-- test execution  
-- workspace tools  
-- Model Context Protocol (MCP) servers  
-- repo indexing and project intelligence  
-- prompt caching  
-- conversational sessions  
+- code navigation
+- diff review
+- [Git operations](#git-tools-and-workflow-automation)
+- test execution
+- workspace tools
+- [Model Context Protocol (MCP) servers](#full-model-context-protocol-mcp-integration)
+- [repo indexing and project intelligence](#-repo-intelligence--indexing)
+- [prompt caching](#prompt-caching-lru--ttl)
+- [conversational sessions with long-term memory](#-long-term-memory-system-titans-inspired)
 
-This makes Databricks a first-class environment for **AI-assisted software development**, **LLM agents**, **automated refactoring**, **debugging**, and **ML/ETL workflow exploration**.
+This makes Databricks and other providers a first-class environment for **AI-assisted software development**, **LLM agents**, **automated refactoring**, **debugging**, and **ML/ETL workflow exploration**.
 
 ---
 
@@ -170,7 +174,60 @@ Databricks / Azure Anthropic / OpenRouter / Ollama / llama.cpp
 
 ````
 
-Key directories:
+## Request Flow Visualization
+
+```mermaid
+graph TB
+    A[Claude Code CLI] -->|HTTP POST /v1/messages| B[Lynkr Proxy Server]
+    B --> C{Middleware Stack}
+    C -->|Load Shedding| D{Load OK?}
+    D -->|Yes| E[Request Logging]
+    D -->|No| Z1[503 Service Unavailable]
+    E --> F[Metrics Collection]
+    F --> G[Input Validation]
+    G --> H[Orchestrator]
+
+    H --> I{Check Prompt Cache}
+    I -->|Cache Hit| J[Return Cached Response]
+    I -->|Cache Miss| K{Determine Provider}
+
+    K -->|Simple 0-2 tools| L[Ollama Local]
+    K -->|Moderate 3-14 tools| M[OpenRouter / Azure]
+    K -->|Complex 15+ tools| N[Databricks]
+
+    L --> O[Circuit Breaker Check]
+    M --> O
+    N --> O
+
+    O -->|Closed| P{Provider API}
+    O -->|Open| Z2[Fallback Provider]
+
+    P -->|Databricks| Q1[Databricks API]
+    P -->|OpenRouter| Q2[OpenRouter API]
+    P -->|Ollama| Q3[Ollama Local]
+    P -->|Azure| Q4[Azure Anthropic API]
+    P -->|llama.cpp| Q5[llama.cpp Server]
+
+    Q1 --> R[Response Processing]
+    Q2 --> R
+    Q3 --> R
+    Q4 --> R
+    Q5 --> R
+    Z2 --> R
+
+    R --> S[Format Conversion]
+    S --> T[Cache Response]
+    T --> U[Update Metrics]
+    U --> V[Return to Client]
+    J --> V
+
+    style B fill:#4a90e2,stroke:#333,stroke-width:2px,color:#fff
+    style H fill:#7b68ee,stroke:#333,stroke-width:2px,color:#fff
+    style K fill:#f39c12,stroke:#333,stroke-width:2px
+    style P fill:#2ecc71,stroke:#333,stroke-width:2px,color:#fff
+```
+
+**Key directories:**
 
 - `src/api` → Claude-compatible API proxy
 - `src/orchestrator` → LLM agent runtime loop
@@ -182,7 +239,7 @@ Key directories:
 
 ---
 
-# ⚙ Installation
+# ⚙ Getting Started: Installation & Setup Guide
 
 ## Global install (recommended)
 ```bash
@@ -208,7 +265,7 @@ npm start
 
 ---
 
-# 🔧 Configuring Providers
+# 🔧 Configuration Guide for Multi-Provider Support (Databricks, Azure, OpenRouter, Ollama, llama.cpp)
 
 ## Databricks Setup
 
@@ -664,12 +721,87 @@ This "working nature" allows Lynkr to not just execute commands, but to **learn
 
 ---
 
+# 📚 References & Further Reading
+
+## Academic & Technical Resources
+
+**Agentic AI Systems:**
+- **Zhang et al. (2024)**. *Agentic Context Engineering*. arXiv:2510.04618. [arXiv](https://arxiv.org/abs/2510.04618)
+
+**Long-Term Memory & RAG:**
+- **Mohtashami & Jaggi (2023)**. *Landmark Attention: Random-Access Infinite Context Length for Transformers*. [arXiv](https://arxiv.org/abs/2305.16300)
+- **Google DeepMind (2024)**. *Titans: Learning to Memorize at Test Time*. [arXiv](https://arxiv.org/abs/2411.07043)
+
+## Official Documentation
+
+- [Claude Code CLI Documentation](https://docs.anthropic.com/en/docs/build-with-claude/claude-for-sheets) - Official Claude Code reference
+- [Model Context Protocol (MCP) Specification](https://spec.modelcontextprotocol.io/) - MCP protocol documentation
+- [Databricks Foundation Models](https://docs.databricks.com/en/machine-learning/foundation-models/index.html) - Databricks LLM documentation
+- [Anthropic API Documentation](https://docs.anthropic.com/en/api/getting-started) - Claude API reference
+
+## Related Projects & Tools
+
+- [Ollama](https://ollama.ai/) - Local LLM runtime for running open-source models
+- [OpenRouter](https://openrouter.ai/) - Multi-provider LLM API gateway (100+ models)
+- [llama.cpp](https://github.com/ggerganov/llama.cpp) - High-performance C++ LLM inference engine
+- [LiteLLM](https://github.com/BerriAI/litellm) - Multi-provider LLM proxy (alternative approach)
+- [Awesome MCP Servers](https://github.com/punkpeye/awesome-mcp-servers) - Curated list of MCP server implementations
+
+---
+
+# 🌟 Community & Adoption
+
+## Get Involved
+
+**⭐ Star this repository** to show your support and help others discover Lynkr!
+
+[![GitHub stars](https://img.shields.io/github/stars/vishalveerareddy123/Lynkr?style=social)](https://github.com/vishalveerareddy123/Lynkr)
+
+## Support & Resources
+
+- 🐛 **Report Issues:** [GitHub Issues](https://github.com/vishalveerareddy123/Lynkr/issues) - Bug reports and feature requests
+- 💬 **Discussions:** [GitHub Discussions](https://github.com/vishalveerareddy123/Lynkr/discussions) - Questions, ideas, and community help
+- 📚 **Documentation:** [DeepWiki](https://deepwiki.com/vishalveerareddy123/Lynkr) - Comprehensive guides and examples
+- 🔧 **Contributing:** [CONTRIBUTING.md](https://github.com/vishalveerareddy123/Lynkr/blob/main/CONTRIBUTING.md) - How to contribute to Lynkr
+
+## Share Lynkr
+
+Help spread the word about Lynkr:
+
+- 🐦 [Share on Twitter](https://twitter.com/intent/tweet?text=Check%20out%20Lynkr%20-%20a%20production-ready%20Claude%20Code%20proxy%20with%20multi-provider%20support%20and%2060-80%25%20token%20savings!&url=https://github.com/vishalveerareddy123/Lynkr&hashtags=AI,ClaudeCode,LLM,OpenSource)
+- 💼 [Share on LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/vishalveerareddy123/Lynkr)
+- 📰 [Share on Hacker News](https://news.ycombinator.com/submitlink?u=https://github.com/vishalveerareddy123/Lynkr&t=Lynkr%20-%20Production-Ready%20Claude%20Code%20Proxy)
+- 📱 [Share on Reddit](https://www.reddit.com/submit?url=https://github.com/vishalveerareddy123/Lynkr&title=Lynkr%20-%20Production-Ready%20Claude%20Code%20Proxy%20with%20Multi-Provider%20Support)
+
+## Why Developers Choose Lynkr
+
+- 💰 **Massive cost savings** - Save 60-80% on token costs with built-in optimization
+- 🔓 **Provider freedom** - Choose from 7+ LLM providers (Databricks, OpenRouter, Ollama, Azure, llama.cpp)
+- 🏠 **Privacy & control** - Self-hosted, open-source, no vendor lock-in
+- 🚀 **Production-ready** - Enterprise features: circuit breakers, metrics, health checks
+- 🛠️ **Active development** - Regular updates, responsive maintainers, growing community
+
+---
+
 # 🔗 Links
 
 * **GitHub**: [https://github.com/vishalveerareddy123/Lynkr](https://github.com/vishalveerareddy123/Lynkr)
 * **Docs**: [https://deepwiki.com/vishalveerareddy123/Lynkr](https://deepwiki.com/vishalveerareddy123/Lynkr)
 * **Issues**: [https://github.com/vishalveerareddy123/Lynkr/issues](https://github.com/vishalveerareddy123/Lynkr/issues)
 
-If you use Databricks or Azure Anthropic and want rich Claude Code workflows, Lynkr gives you the control and extensibility you need.
+---
+
+## 🚀 Ready to Get Started?
+
+**Reduce your Claude Code costs by 60-80% today:**
+
+1. ⭐ **[Star this repo](https://github.com/vishalveerareddy123/Lynkr)** to show support and stay updated
+2. 📖 **[Install Lynkr](#-getting-started-installation--setup-guide)** and configure your preferred provider
+3. 💬 **[Join the Discussion](https://github.com/vishalveerareddy123/Lynkr/discussions)** for community support
+4. 🐛 **[Report Issues](https://github.com/vishalveerareddy123/Lynkr/issues)** to help improve Lynkr
+
+---
+
+If you use Databricks, Azure Anthropic, OpenRouter, Ollama, or llama.cpp and want rich Claude Code workflows with massive cost savings, Lynkr gives you the control, flexibility, and extensibility you need.
 
-Feel free to open issues, contribute tools, or integrate with MCP servers!
+Feel free to open issues, contribute tools, integrate with MCP servers, or help us improve the documentation!

package/install.sh

@@ -16,7 +16,7 @@ BLUE='\033[0;34m'
 NC='\033[0m' # No Color
 
 # Configuration
-REPO_URL="https://github.com/vishalveerareddy123/Lynkr"
+REPO_URL="https://github.com/Fast-Editor/Lynkr"
 INSTALL_DIR="${LYNKR_INSTALL_DIR:-$HOME/.lynkr}"
 BRANCH="${LYNKR_BRANCH:-main}"
 
@@ -115,12 +115,19 @@ install_dependencies() {
 # Create default .env file
 create_env_file() {
     if [ ! -f "$INSTALL_DIR/.env" ]; then
-        print_info "Creating default .env file..."
-        cp "$INSTALL_DIR/.env.example" "$INSTALL_DIR/.env" 2>/dev/null || cat > "$INSTALL_DIR/.env" << 'EOF'
+        print_info "Creating .env configuration file..."
+
+        # Try to copy from .env.example (comprehensive configuration)
+        if [ -f "$INSTALL_DIR/.env.example" ]; then
+            cp "$INSTALL_DIR/.env.example" "$INSTALL_DIR/.env"
+            print_success "Created .env from .env.example (all features documented)"
+        else
+            # Fallback: create minimal .env if .env.example doesn't exist
+            cat > "$INSTALL_DIR/.env" << 'EOF'
 # Lynkr Configuration
-# See .env.example for all options
+# For full options, see: https://github.com/vishalveerareddy123/Lynkr/blob/main/.env.example
 
-# Model Provider (databricks, openai, azure-openai, azure-anthropic, openrouter, ollama)
+# Model Provider (databricks, openai, azure-openai, azure-anthropic, openrouter, ollama, llamacpp)
 MODEL_PROVIDER=ollama
 
 # Server Configuration
@@ -131,13 +138,29 @@ PREFER_OLLAMA=true
 OLLAMA_MODEL=qwen2.5-coder:7b
 OLLAMA_ENDPOINT=http://localhost:11434
 
-# Uncomment and configure your preferred provider:
+# Long-Term Memory System (Titans-Inspired) - Enabled by default
+MEMORY_ENABLED=true
+MEMORY_RETRIEVAL_LIMIT=5
+MEMORY_SURPRISE_THRESHOLD=0.3
+
+# Uncomment and configure your preferred cloud provider:
 # OPENAI_API_KEY=sk-your-key
 # OPENROUTER_API_KEY=your-key
 # DATABRICKS_API_KEY=your-key
 # DATABRICKS_API_BASE=https://your-workspace.databricks.com
 EOF
-        print_success "Created .env file (edit to configure your API keys)"
+            print_success "Created basic .env file"
+        fi
+
+        echo ""
+        print_info "📝 Configuration ready! Key settings:"
+        echo "     • Default provider: Ollama (local, offline)"
+        echo "     • Memory system: Enabled (learns from conversations)"
+        echo "     • Port: 8080"
+        echo ""
+        print_warning "To use cloud providers (Databricks/OpenAI/Azure):"
+        echo "     Edit: ${BLUE}nano $INSTALL_DIR/.env${NC}"
+        echo "     Add your API keys and change MODEL_PROVIDER"
     else
         print_warning ".env file already exists, skipping"
     fi
@@ -180,23 +203,47 @@ print_next_steps() {
     print_success "Lynkr installed successfully!"
     echo "=============================="
     echo ""
-    echo "Next steps:"
+    echo "🚀 Quick Start Guide:"
     echo ""
-    echo "  1. Configure your API keys:"
-    echo "     ${BLUE}nano $INSTALL_DIR/.env${NC}"
+    echo "  ${GREEN}Option A: Use Ollama (Free, Local, Offline)${NC}"
+    echo "  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    echo ""
+    echo "  1. Install Ollama (if not already installed):"
+    echo "     ${BLUE}lynkr-setup${NC}  ${GREEN}← Automatic Ollama installer${NC}"
     echo ""
     echo "  2. Start Lynkr:"
-    echo "     ${BLUE}cd $INSTALL_DIR && npm start${NC}"
-    echo "     or"
-    echo "     ${BLUE}lynkr${NC} (if in PATH)"
+    echo "     ${BLUE}lynkr${NC}"
     echo ""
-    echo "  3. Configure Claude CLI to use Lynkr:"
+    echo "  3. Configure Claude Code CLI:"
     echo "     ${BLUE}export ANTHROPIC_BASE_URL=http://localhost:8080${NC}"
+    echo "     ${BLUE}claude${NC}"
     echo ""
-    echo "  4. Run Claude Code:"
+    echo "  ${YELLOW}Option B: Use Cloud Providers (Databricks/OpenAI/Azure)${NC}"
+    echo "  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    echo ""
+    echo "  1. Edit configuration file:"
+    echo "     ${BLUE}nano $INSTALL_DIR/.env${NC}"
+    echo ""
+    echo "     Update these lines:"
+    echo "     ${BLUE}MODEL_PROVIDER=databricks${NC}  ${GREEN}← Change from 'ollama'${NC}"
+    echo "     ${BLUE}DATABRICKS_API_KEY=dapi_xxxxx${NC}  ${GREEN}← Add your key${NC}"
+    echo "     ${BLUE}DATABRICKS_API_BASE=https://your-workspace.databricks.com${NC}"
+    echo ""
+    echo "  2. Start Lynkr:"
+    echo "     ${BLUE}lynkr${NC}"
+    echo ""
+    echo "  3. Configure Claude Code CLI:"
+    echo "     ${BLUE}export ANTHROPIC_BASE_URL=http://localhost:8080${NC}"
+    echo "     ${BLUE}export ANTHROPIC_API_KEY=any-non-empty-value${NC}  ${GREEN}← Placeholder${NC}"
     echo "     ${BLUE}claude${NC}"
     echo ""
-    echo "Documentation: https://github.com/vishalveerareddy123/Lynkr"
+    echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+    echo ""
+    echo "💡 ${YELLOW}Tip:${NC} Memory system is enabled by default"
+    echo "   Lynkr remembers preferences and project context across sessions"
+    echo ""
+    echo "📚 Documentation: ${BLUE}https://github.com/vishalveerareddy123/Lynkr${NC}"
+    echo "💬 Discord: ${BLUE}https://discord.gg/qF7DDxrX${NC}"
     echo ""
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lynkr",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Self-hosted Claude Code proxy with Databricks,Azure  adapters, openrouter, Ollama,llamacpp, workspace tooling, and MCP integration.",
   "main": "index.js",
   "bin": {