# LightRAG MCP Server
[English](#english) | [正體中文](#正體中文)
---
<a name="english"></a>
## English
A Model Context Protocol (MCP) server that provides a bridge to the LightRAG knowledge base. This allows AI assistants like Claude to query your technical documentation directly.
### Features
- **Knowledge Base Querying**: Access your private documents through LightRAG.
- **Language Support**: Built-in support for **Traditional Chinese** and **English**.
- **Flexible Modes**: Support for `hybrid`, `naive`, `local`, and `global` retrieval modes.
- **Easy Configuration**: Simple environment variable setup.
### Quick Start
1. **Installation**
```bash
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install -r requirements.txt
```
2. **Configuration**
Copy `.env.example` to `.env` and set:
- `LIGHTRAG_URL`: Your LightRAG backend URL.
- `LIGHTRAG_LANG`: Default language (`zh` or `en`).
3. **Run**
```bash
python lightrag_mcp.py
```
### Tool: `query_knowledge_base`
- `query` (string): Search query.
- `mode` (string): `hybrid` (default), `naive`, `local`, `global`.
- `lang` (string): `zh` (Traditional Chinese) or `en` (English).
---
<a name="正體中文"></a>
## 正體中文
基於 Model Context Protocol (MCP) 的伺服器，作為 LightRAG 知識庫的橋樑。讓 AI 助手（如 Claude）可以直接查詢您的技術文件。
### 核心功能
- **知識庫查詢**：透過 LightRAG 存取您的私有文件。
- **多語言支援**：內建支援**正體中文**與**英文**。
- **靈活模式**：支援 `hybrid`、`naive`、`local` 與 `global` 檢索模式。
- **簡易配置**：透過環境變數輕鬆設定。
### 快速啟動
1. **安裝**
```bash
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install -r requirements.txt
```
2. **配置**
複製 `.env.example` 為 `.env` 並設定：
- `LIGHTRAG_URL`: LightRAG 後端 URL。
- `LIGHTRAG_LANG`: 預設語言 (`zh` 或 `en`)。
3. **執行**
```bash
python lightrag_mcp.py
```
### 工具：`query_knowledge_base`
- `query` (字串)：查詢字句或問題。
- `mode` (字串)：檢索模式，可選 `hybrid` (預設), `naive`, `local`, `global`。
- `lang` (字串)：語言切換，可選 `zh` (正體中文) 或 `en` (英文)。
---
## Development / 開發規範
See [AGENTS.md](./AGENTS.md) for detailed guidelines. / 請參閱 [AGENTS.md](./AGENTS.md) 了解詳細開發規範。
## License
MIT
