Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
07eb8604f5 |
@@ -38,6 +38,7 @@ dependencies = [
|
||||
|
||||
[project.optional-dependencies]
|
||||
modal = ["modal>=1.0.0,<2"]
|
||||
rag = ["lightrag-hku>=1.4.0,<2", "aiohttp>=3.9.0,<4"]
|
||||
daytona = ["daytona>=0.148.0,<1"]
|
||||
dev = ["debugpy>=1.8.0,<2", "pytest>=9.0.2,<10", "pytest-asyncio>=1.3.0,<2", "pytest-xdist>=3.0,<4", "mcp>=1.2.0,<2"]
|
||||
messaging = ["python-telegram-bot[webhooks]>=22.6,<23", "discord.py[voice]>=2.7.1,<3", "aiohttp>=3.13.3,<4", "slack-bolt>=1.18.0,<2", "slack-sdk>=3.27.0,<4"]
|
||||
|
||||
176
tests/tools/test_lightrag_tool.py
Normal file
176
tests/tools/test_lightrag_tool.py
Normal file
@@ -0,0 +1,176 @@
|
||||
"""Tests for tools/lightrag_tool.py"""
|
||||
|
||||
import json
|
||||
import sys
|
||||
from pathlib import Path
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
|
||||
# LightRAG may not be installed in all test environments
|
||||
pytest.importorskip("lightrag", reason="lightrag-hku not installed")
|
||||
|
||||
from tools.lightrag_tool import (
|
||||
check_lightrag_requirements,
|
||||
lightrag_index,
|
||||
lightrag_query,
|
||||
_collect_markdown_files,
|
||||
_read_text_safe,
|
||||
LIGHTRAG_DIR,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _parse_result(result: str) -> dict:
|
||||
"""Parse JSON tool result, falling back to error string detection."""
|
||||
try:
|
||||
return json.loads(result)
|
||||
except json.JSONDecodeError:
|
||||
return {"_error": result}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Unit tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestCollectMarkdownFiles:
|
||||
def test_collects_md_files(self, tmp_path):
|
||||
(tmp_path / "a.md").write_text("# A")
|
||||
(tmp_path / "b.md").write_text("# B")
|
||||
(tmp_path / "skip.txt").write_text("text")
|
||||
found = _collect_markdown_files(tmp_path)
|
||||
assert len(found) == 2
|
||||
assert all(p.suffix == ".md" for p in found)
|
||||
|
||||
def test_skips_hidden_dirs(self, tmp_path):
|
||||
(tmp_path / ".git").mkdir()
|
||||
(tmp_path / ".git" / "readme.md").write_text("# git")
|
||||
(tmp_path / "visible.md").write_text("# visible")
|
||||
found = _collect_markdown_files(tmp_path)
|
||||
names = [p.name for p in found]
|
||||
assert "visible.md" in names
|
||||
assert "readme.md" not in names
|
||||
|
||||
def test_returns_empty_for_missing_dir(self):
|
||||
assert _collect_markdown_files(Path("/nonexistent")) == []
|
||||
|
||||
|
||||
class TestReadTextSafe:
|
||||
def test_reads_small_file(self, tmp_path):
|
||||
p = tmp_path / "test.md"
|
||||
p.write_text("hello world")
|
||||
assert _read_text_safe(p) == "hello world"
|
||||
|
||||
def test_truncates_large_file(self, tmp_path):
|
||||
p = tmp_path / "big.md"
|
||||
p.write_text("x" * 1_000_000)
|
||||
text = _read_text_safe(p, limit=500_000)
|
||||
assert len(text) == 500_000
|
||||
|
||||
def test_reads_binary_without_crashing(self, tmp_path):
|
||||
p = tmp_path / "binary.md"
|
||||
p.write_bytes(b"\x00\x01\x02")
|
||||
result = _read_text_safe(p)
|
||||
# Should not crash; control chars 0x00-0x7F are valid UTF-8
|
||||
assert isinstance(result, str)
|
||||
|
||||
|
||||
class TestCheckRequirements:
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=True)
|
||||
def test_ok_when_ollama_up(self, mock_ollama):
|
||||
assert check_lightrag_requirements() is True
|
||||
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=False)
|
||||
def test_false_when_ollama_down(self, mock_ollama):
|
||||
assert check_lightrag_requirements() is False
|
||||
|
||||
@patch.dict(sys.modules, {"lightrag": None}, clear=False)
|
||||
def test_false_when_lightrag_missing(self):
|
||||
with patch("tools.lightrag_tool._ollama_available", return_value=True):
|
||||
# Force ImportError by removing lightrag from sys.modules
|
||||
# and blocking import
|
||||
assert check_lightrag_requirements() is False
|
||||
|
||||
|
||||
class TestLightragIndex:
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=False)
|
||||
def test_error_when_ollama_down(self, mock_ollama):
|
||||
result = lightrag_index()
|
||||
assert "Ollama is not running" in result
|
||||
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=True)
|
||||
@patch("tools.lightrag_tool._has_ollama_model", return_value=False)
|
||||
def test_error_when_model_missing(self, mock_model, mock_ollama):
|
||||
result = lightrag_index()
|
||||
assert "not found in Ollama" in result
|
||||
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=True)
|
||||
@patch("tools.lightrag_tool._has_ollama_model", return_value=True)
|
||||
@patch("tools.lightrag_tool._get_lightrag")
|
||||
@patch("tools.lightrag_tool._collect_markdown_files", return_value=[])
|
||||
def test_warning_when_no_files(self, mock_collect, mock_get_rag, mock_model, mock_ollama):
|
||||
result = lightrag_index()
|
||||
data = _parse_result(result)
|
||||
assert data.get("status") == "warning"
|
||||
assert "No markdown files found" in data.get("message", "")
|
||||
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=True)
|
||||
@patch("tools.lightrag_tool._has_ollama_model", return_value=True)
|
||||
@patch("tools.lightrag_tool._get_lightrag")
|
||||
@patch("tools.lightrag_tool._collect_markdown_files")
|
||||
@patch("tools.lightrag_tool._read_text_safe", return_value="# Skill doc\nContent.")
|
||||
@patch("asyncio.run")
|
||||
def test_indexes_files(self, mock_asyncio, mock_read, mock_collect, mock_get_rag, mock_model, mock_ollama):
|
||||
mock_collect.return_value = [Path("/fake/skills/git.md"), Path("/fake/skills/docker.md")]
|
||||
mock_rag = MagicMock()
|
||||
mock_get_rag.return_value = mock_rag
|
||||
|
||||
result = lightrag_index()
|
||||
data = _parse_result(result)
|
||||
assert data.get("status") == "ok"
|
||||
assert data.get("indexed_files") == 2
|
||||
assert data.get("errors") == 0
|
||||
|
||||
|
||||
class TestLightragQuery:
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=False)
|
||||
def test_error_when_ollama_down(self, mock_ollama):
|
||||
result = lightrag_query("test", mode="hybrid")
|
||||
assert "Ollama is not running" in result
|
||||
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=True)
|
||||
@patch("tools.lightrag_tool.LIGHTRAG_DIR")
|
||||
def test_empty_index_message(self, mock_dir, mock_ollama):
|
||||
mock_dir.exists.return_value = True
|
||||
mock_dir.iterdir.return_value = iter([])
|
||||
result = lightrag_query("test", mode="hybrid")
|
||||
data = _parse_result(result)
|
||||
assert data.get("status") == "empty"
|
||||
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=True)
|
||||
@patch("tools.lightrag_tool.LIGHTRAG_DIR")
|
||||
@patch("tools.lightrag_tool._get_lightrag")
|
||||
@patch("asyncio.run", return_value="Use git clone for repos.")
|
||||
def test_query_returns_answer(self, mock_asyncio, mock_get_rag, mock_dir, mock_ollama):
|
||||
mock_dir.exists.return_value = True
|
||||
mock_dir.iterdir.return_value = iter([Path("dummy")])
|
||||
mock_rag = MagicMock()
|
||||
mock_get_rag.return_value = mock_rag
|
||||
|
||||
result = lightrag_query("How do I clone a repo?", mode="hybrid")
|
||||
data = _parse_result(result)
|
||||
assert data.get("status") == "ok"
|
||||
assert data.get("mode") == "hybrid"
|
||||
assert "clone" in data.get("answer", "").lower()
|
||||
|
||||
@patch("tools.lightrag_tool._ollama_available", return_value=True)
|
||||
def test_rejects_invalid_mode(self, mock_ollama):
|
||||
result = lightrag_query("test", mode="invalid")
|
||||
assert "mode must be one of" in result
|
||||
|
||||
def test_rejects_empty_query(self):
|
||||
result = lightrag_query("", mode="hybrid")
|
||||
assert "Query cannot be empty" in result
|
||||
@@ -308,12 +308,12 @@ word word
|
||||
content = """\
|
||||
---
|
||||
name: test-skill
|
||||
description: A test skill with enough content to pass the minimum length validation check of one hundred characters.
|
||||
description: A test skill.
|
||||
---
|
||||
|
||||
# Test
|
||||
|
||||
word word word word word word word word word word
|
||||
word word
|
||||
"""
|
||||
with _skill_dir(tmp_path):
|
||||
_create_skill("my-skill", content)
|
||||
@@ -484,185 +484,3 @@ class TestSkillManageDispatcher:
|
||||
raw = skill_manage(action="create", name="test-skill", content=VALID_SKILL_CONTENT)
|
||||
result = json.loads(raw)
|
||||
assert result["success"] is True
|
||||
|
||||
|
||||
|
||||
class TestPokaYokeValidation:
|
||||
"""Tests for poka-yoke auto-revert functionality (#837)."""
|
||||
|
||||
def test_short_skill_md_reverts(self, tmp_path):
|
||||
"""SKILL.md shorter than 100 chars should be reverted."""
|
||||
short_content = """---
|
||||
name: test-skill
|
||||
description: Test
|
||||
---
|
||||
|
||||
Short
|
||||
"""
|
||||
with _skill_dir(tmp_path):
|
||||
_create_skill("my-skill", VALID_SKILL_CONTENT)
|
||||
result = _edit_skill("my-skill", short_content)
|
||||
|
||||
assert result["success"] is False
|
||||
assert "too short" in result["error"].lower()
|
||||
|
||||
# Verify the original file is preserved
|
||||
skill_md = tmp_path / "my-skill" / "SKILL.md"
|
||||
content = skill_md.read_text()
|
||||
assert "test-skill" in content # Original content preserved
|
||||
|
||||
def test_truncated_skill_reverts(self, tmp_path):
|
||||
"""Truncated YAML frontmatter should be reverted."""
|
||||
truncated = """---
|
||||
name: test-skill
|
||||
description: Test skill with enough content to pass minimum length validation check.
|
||||
---
|
||||
|
||||
# Test
|
||||
|
||||
This is a longer body section with plenty of text to ensure the content exceeds the minimum one hundred character requirement for SKILL.md files.
|
||||
"""
|
||||
# Chop it off to simulate truncation
|
||||
truncated = truncated[:80]
|
||||
|
||||
with _skill_dir(tmp_path):
|
||||
_create_skill("my-skill", VALID_SKILL_CONTENT)
|
||||
result = _edit_skill("my-skill", truncated)
|
||||
|
||||
assert result["success"] is False
|
||||
|
||||
def test_linked_files_validation(self, tmp_path):
|
||||
"""Missing linked_files should cause revert."""
|
||||
content_with_links = """---
|
||||
name: test-skill
|
||||
description: Test skill with enough content to pass minimum length validation check.
|
||||
linked_files:
|
||||
- references/nonexistent.md
|
||||
---
|
||||
|
||||
# Test
|
||||
|
||||
This is a longer body section with plenty of text to ensure the content exceeds the minimum one hundred character requirement for SKILL.md files.
|
||||
"""
|
||||
with _skill_dir(tmp_path):
|
||||
_create_skill("my-skill", VALID_SKILL_CONTENT)
|
||||
result = _edit_skill("my-skill", content_with_links)
|
||||
|
||||
assert result["success"] is False
|
||||
assert "linked files missing" in result["error"].lower()
|
||||
|
||||
def test_valid_linked_files_pass(self, tmp_path):
|
||||
"""Existing linked_files should pass validation."""
|
||||
content_with_links = """---
|
||||
name: test-skill
|
||||
description: Test skill with enough content to pass minimum length validation check.
|
||||
linked_files:
|
||||
- references/exists.md
|
||||
---
|
||||
|
||||
# Test
|
||||
|
||||
This is a longer body section with plenty of text to ensure the content exceeds the minimum one hundred character requirement for SKILL.md files.
|
||||
"""
|
||||
with _skill_dir(tmp_path):
|
||||
_create_skill("my-skill", VALID_SKILL_CONTENT)
|
||||
# Create the linked file
|
||||
ref_dir = tmp_path / "my-skill" / "references"
|
||||
ref_dir.mkdir(parents=True, exist_ok=True)
|
||||
(ref_dir / "exists.md").write_text("# Reference")
|
||||
|
||||
result = _edit_skill("my-skill", content_with_links)
|
||||
|
||||
assert result["success"] is True
|
||||
|
||||
|
||||
class TestHistoryRegistry:
|
||||
"""Tests for history registry functionality (#837)."""
|
||||
|
||||
def test_history_saved_on_edit(self, tmp_path):
|
||||
"""Editing a skill should save the original to history."""
|
||||
with _skill_dir(tmp_path):
|
||||
_create_skill("my-skill", VALID_SKILL_CONTENT)
|
||||
|
||||
# Make an edit
|
||||
new_content = """---
|
||||
name: test-skill
|
||||
description: Updated description that is longer than one hundred characters to pass validation.
|
||||
---
|
||||
|
||||
# Updated Test
|
||||
|
||||
This body has more content to ensure it passes the minimum length check of one hundred characters.
|
||||
"""
|
||||
result = _edit_skill("my-skill", new_content)
|
||||
assert result["success"] is True
|
||||
|
||||
# Check history was saved
|
||||
history_dir = tmp_path / ".history" / "my-skill"
|
||||
assert history_dir.exists()
|
||||
history_files = list(history_dir.glob("*.md"))
|
||||
assert len(history_files) == 1
|
||||
|
||||
def test_history_pruned_to_three(self, tmp_path):
|
||||
"""Only last 3 history versions should be kept."""
|
||||
from tools.skill_manager_tool import _save_to_history
|
||||
|
||||
with _skill_dir(tmp_path):
|
||||
_create_skill("my-skill", VALID_SKILL_CONTENT)
|
||||
|
||||
# Save 5 versions to history
|
||||
for i in range(5):
|
||||
content = f"""---
|
||||
name: test-skill
|
||||
description: Version {i} that is long enough to pass minimum length validation check of one hundred characters.
|
||||
---
|
||||
|
||||
# Version {i}
|
||||
|
||||
This is the body content for version {i} that ensures we meet the minimum length requirement.
|
||||
"""
|
||||
_save_to_history("my-skill", content, timestamp=1000 + i)
|
||||
|
||||
# Check only 3 history files remain
|
||||
history_dir = tmp_path / ".history" / "my-skill"
|
||||
history_files = sorted(history_dir.glob("*.md"))
|
||||
assert len(history_files) == 3
|
||||
# Should be the last 3 (timestamps 1002, 1003, 1004)
|
||||
assert "1002" in str(history_files[0])
|
||||
|
||||
def test_revert_to_history(self, tmp_path):
|
||||
"""Should be able to revert to a history version."""
|
||||
from tools.skill_manager_tool import _revert_to_history, _get_history_versions
|
||||
|
||||
with _skill_dir(tmp_path):
|
||||
_create_skill("my-skill", VALID_SKILL_CONTENT)
|
||||
skill_md = tmp_path / "my-skill" / "SKILL.md"
|
||||
|
||||
# Save original to history
|
||||
original = skill_md.read_text()
|
||||
from tools.skill_manager_tool import _save_to_history
|
||||
_save_to_history("my-skill", original)
|
||||
|
||||
# Edit the skill
|
||||
new_content = """---
|
||||
name: test-skill
|
||||
description: Updated description that is longer than one hundred characters to pass validation.
|
||||
---
|
||||
|
||||
# Updated
|
||||
|
||||
This body has more content to ensure it passes the minimum length check of one hundred characters.
|
||||
"""
|
||||
_edit_skill("my-skill", new_content)
|
||||
|
||||
# Verify edit was applied
|
||||
assert "Updated" in skill_md.read_text()
|
||||
|
||||
# Revert to history
|
||||
error = _revert_to_history("my-skill", skill_md, version=0)
|
||||
assert error is None
|
||||
|
||||
# Verify revert worked
|
||||
content = skill_md.read_text()
|
||||
assert "test-skill" in content
|
||||
assert "A test skill" in content
|
||||
|
||||
405
tools/lightrag_tool.py
Normal file
405
tools/lightrag_tool.py
Normal file
@@ -0,0 +1,405 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
LightRAG Tool — Graph-based knowledge retrieval for skills and docs.
|
||||
|
||||
Indexes markdown files under ~/.hermes/skills/ (and optional extra dirs)
|
||||
into a LightRAG knowledge graph stored at ~/.hermes/lightrag/.
|
||||
|
||||
Requires:
|
||||
- lightrag-hku (pip install lightrag-hku)
|
||||
- Ollama running locally with an embedding model (default: nomic-embed-text)
|
||||
- Ollama running locally with a chat model (default: qwen2.5:7b)
|
||||
|
||||
Usage:
|
||||
lightrag_query("How do I dispatch the burn fleet?", mode="hybrid")
|
||||
lightrag_index() # re-index skill files
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Optional
|
||||
|
||||
import numpy as np
|
||||
|
||||
from hermes_constants import get_hermes_home
|
||||
from tools.registry import registry, tool_error
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Config
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
DEFAULT_EMBED_MODEL = os.environ.get("LIGHTRAG_EMBED_MODEL", "nomic-embed-text")
|
||||
DEFAULT_LLM_MODEL = os.environ.get("LIGHTRAG_LLM_MODEL", "qwen2.5:7b")
|
||||
DEFAULT_OLLAMA_HOST = os.environ.get("LIGHTRAG_OLLAMA_HOST", "http://localhost:11434")
|
||||
|
||||
LIGHTRAG_DIR = get_hermes_home() / "lightrag"
|
||||
SKILLS_DIR = get_hermes_home() / "skills"
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Ollama helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def _ollama_available() -> bool:
|
||||
"""Check if Ollama server is reachable."""
|
||||
try:
|
||||
import urllib.request
|
||||
req = urllib.request.Request(f"{DEFAULT_OLLAMA_HOST}/api/tags")
|
||||
with urllib.request.urlopen(req, timeout=3) as resp:
|
||||
return resp.status == 200
|
||||
except Exception:
|
||||
return False
|
||||
|
||||
|
||||
def _has_ollama_model(model_name: str) -> bool:
|
||||
"""Check if a specific model is pulled in Ollama."""
|
||||
try:
|
||||
import urllib.request
|
||||
req = urllib.request.Request(f"{DEFAULT_OLLAMA_HOST}/api/tags")
|
||||
with urllib.request.urlopen(req, timeout=3) as resp:
|
||||
data = json.loads(resp.read())
|
||||
models = [m["name"] for m in data.get("models", [])]
|
||||
return any(model_name in m for m in models)
|
||||
except Exception:
|
||||
return False
|
||||
|
||||
|
||||
async def _ollama_embedding(texts: list, **kwargs) -> np.ndarray:
|
||||
"""Call Ollama embeddings API."""
|
||||
import aiohttp
|
||||
|
||||
payload = {
|
||||
"model": DEFAULT_EMBED_MODEL,
|
||||
"input": texts,
|
||||
}
|
||||
async with aiohttp.ClientSession() as session:
|
||||
async with session.post(
|
||||
f"{DEFAULT_OLLAMA_HOST}/api/embed",
|
||||
json=payload,
|
||||
timeout=aiohttp.ClientTimeout(total=60),
|
||||
) as resp:
|
||||
resp.raise_for_status()
|
||||
data = await resp.json()
|
||||
embeddings = data.get("embeddings", [])
|
||||
if not embeddings:
|
||||
raise RuntimeError("Ollama returned empty embeddings")
|
||||
return np.array(embeddings, dtype=np.float32)
|
||||
|
||||
|
||||
async def _ollama_complete(
|
||||
prompt, system_prompt=None, history_messages=None, **kwargs
|
||||
) -> str:
|
||||
"""Call Ollama generate API for LLM completion."""
|
||||
import aiohttp
|
||||
|
||||
messages = []
|
||||
if system_prompt:
|
||||
messages.append({"role": "system", "content": system_prompt})
|
||||
if history_messages:
|
||||
for msg in history_messages:
|
||||
role = "user" if msg.get("role") == "user" else "assistant"
|
||||
messages.append({"role": role, "content": msg.get("content", "")})
|
||||
messages.append({"role": "user", "content": prompt})
|
||||
|
||||
payload = {
|
||||
"model": DEFAULT_LLM_MODEL,
|
||||
"messages": messages,
|
||||
"stream": False,
|
||||
"options": {"temperature": 0.3, "num_predict": 2048},
|
||||
}
|
||||
async with aiohttp.ClientSession() as session:
|
||||
async with session.post(
|
||||
f"{DEFAULT_OLLAMA_HOST}/api/chat",
|
||||
json=payload,
|
||||
timeout=aiohttp.ClientTimeout(total=120),
|
||||
) as resp:
|
||||
resp.raise_for_status()
|
||||
data = await resp.json()
|
||||
return data.get("message", {}).get("content", "")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# LightRAG setup
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
_lightrag_instance: Optional[object] = None
|
||||
|
||||
|
||||
def _get_lightrag() -> object:
|
||||
"""Lazy-initialize LightRAG with Ollama backends."""
|
||||
global _lightrag_instance
|
||||
if _lightrag_instance is not None:
|
||||
return _lightrag_instance
|
||||
|
||||
try:
|
||||
from lightrag import LightRAG, QueryParam
|
||||
from lightrag.utils import EmbeddingFunc
|
||||
except ImportError as e:
|
||||
raise RuntimeError(
|
||||
"lightrag is not installed. Run: pip install lightrag-hku"
|
||||
) from e
|
||||
|
||||
LIGHTRAG_DIR.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Wrap Ollama embedding for LightRAG
|
||||
embed_func = EmbeddingFunc(
|
||||
embedding_dim=768, # nomic-embed-text dimension
|
||||
func=_ollama_embedding,
|
||||
max_token_size=8192,
|
||||
model_name=DEFAULT_EMBED_MODEL,
|
||||
)
|
||||
|
||||
_lightrag_instance = LightRAG(
|
||||
working_dir=str(LIGHTRAG_DIR),
|
||||
embedding_func=embed_func,
|
||||
llm_model_func=_ollama_complete,
|
||||
llm_model_name=DEFAULT_LLM_MODEL,
|
||||
chunk_token_size=1200,
|
||||
chunk_overlap_token_size=100,
|
||||
)
|
||||
return _lightrag_instance
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Indexing
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def _collect_markdown_files(root: Path) -> List[Path]:
|
||||
"""Collect all .md files under root, excluding node_modules and .git."""
|
||||
files = []
|
||||
if not root.exists():
|
||||
return files
|
||||
for path in root.rglob("*.md"):
|
||||
if any(part.startswith(".") or part == "node_modules" for part in path.parts):
|
||||
continue
|
||||
files.append(path)
|
||||
return sorted(files)
|
||||
|
||||
|
||||
def _read_text_safe(path: Path, limit: int = 500_000) -> str:
|
||||
"""Read file text with size limit."""
|
||||
try:
|
||||
stat = path.stat()
|
||||
if stat.st_size > limit:
|
||||
return path.read_text(encoding="utf-8", errors="ignore")[:limit]
|
||||
return path.read_text(encoding="utf-8", errors="ignore")
|
||||
except Exception as e:
|
||||
logger.warning("Failed to read %s: %s", path, e)
|
||||
return ""
|
||||
|
||||
|
||||
def lightrag_index(directories: Optional[List[str]] = None) -> str:
|
||||
"""Index markdown files into LightRAG knowledge graph.
|
||||
|
||||
Args:
|
||||
directories: Extra directories to index (in addition to ~/.hermes/skills/).
|
||||
"""
|
||||
if not _ollama_available():
|
||||
return tool_error(
|
||||
"Ollama is not running. Start it with: ollama serve"
|
||||
)
|
||||
|
||||
if not _has_ollama_model(DEFAULT_EMBED_MODEL):
|
||||
return tool_error(
|
||||
f"Embedding model '{DEFAULT_EMBED_MODEL}' not found in Ollama. "
|
||||
f"Pull it with: ollama pull {DEFAULT_EMBED_MODEL}"
|
||||
)
|
||||
|
||||
if not _has_ollama_model(DEFAULT_LLM_MODEL):
|
||||
return tool_error(
|
||||
f"LLM model '{DEFAULT_LLM_MODEL}' not found in Ollama. "
|
||||
f"Pull it with: ollama pull {DEFAULT_LLM_MODEL}"
|
||||
)
|
||||
|
||||
rag = _get_lightrag()
|
||||
dirs = [SKILLS_DIR]
|
||||
if directories:
|
||||
for d in directories:
|
||||
p = Path(d).expanduser()
|
||||
if p.exists():
|
||||
dirs.append(p)
|
||||
|
||||
all_files = []
|
||||
for d in dirs:
|
||||
all_files.extend(_collect_markdown_files(d))
|
||||
|
||||
if not all_files:
|
||||
return json.dumps({
|
||||
"status": "warning",
|
||||
"message": "No markdown files found to index.",
|
||||
"directories": [str(d) for d in dirs],
|
||||
})
|
||||
|
||||
# Read and insert files
|
||||
inserted = 0
|
||||
errors = 0
|
||||
for path in all_files:
|
||||
text = _read_text_safe(path)
|
||||
if not text.strip():
|
||||
continue
|
||||
try:
|
||||
# LightRAG insert is async; bridge it
|
||||
asyncio.run(rag.atext(text))
|
||||
inserted += 1
|
||||
except Exception as e:
|
||||
logger.warning("Failed to index %s: %s", path, e)
|
||||
errors += 1
|
||||
|
||||
return json.dumps({
|
||||
"status": "ok",
|
||||
"indexed_files": inserted,
|
||||
"errors": errors,
|
||||
"total_files": len(all_files),
|
||||
"storage_dir": str(LIGHTRAG_DIR),
|
||||
})
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Query
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def lightrag_query(query: str, mode: str = "hybrid") -> str:
|
||||
"""Query the LightRAG knowledge graph.
|
||||
|
||||
Args:
|
||||
query: The question or search query.
|
||||
mode: Search mode — "local" (nearby entities), "global" (graph-wide),
|
||||
or "hybrid" (both).
|
||||
"""
|
||||
if not query or not query.strip():
|
||||
return tool_error("Query cannot be empty.")
|
||||
|
||||
if mode not in {"local", "global", "hybrid"}:
|
||||
return tool_error("mode must be one of: local, global, hybrid")
|
||||
|
||||
if not _ollama_available():
|
||||
return tool_error(
|
||||
"Ollama is not running. Start it with: ollama serve"
|
||||
)
|
||||
|
||||
rag = _get_lightrag()
|
||||
|
||||
# Check if any data has been indexed
|
||||
if not LIGHTRAG_DIR.exists() or not any(LIGHTRAG_DIR.iterdir()):
|
||||
return json.dumps({
|
||||
"status": "empty",
|
||||
"message": "LightRAG index is empty. Run lightrag_index() first.",
|
||||
})
|
||||
|
||||
try:
|
||||
from lightrag import QueryParam
|
||||
param = QueryParam(mode=mode)
|
||||
result = asyncio.run(rag.aquery(query, param=param))
|
||||
return json.dumps({
|
||||
"status": "ok",
|
||||
"mode": mode,
|
||||
"query": query,
|
||||
"answer": result,
|
||||
})
|
||||
except Exception as e:
|
||||
logger.exception("LightRAG query failed")
|
||||
return tool_error(f"Query failed: {e}")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tool schemas
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
LIGHTRAG_QUERY_SCHEMA = {
|
||||
"name": "lightrag_query",
|
||||
"description": (
|
||||
"Graph-based knowledge retrieval over indexed skills and documentation.\n\n"
|
||||
"Use this when the user asks about: conventions, workflows, tool usage, "
|
||||
"project-specific practices, or anything that might be documented in skills.\n\n"
|
||||
"Modes:\n"
|
||||
"- local: fast, searches nearby entities in the graph\n"
|
||||
"- global: thorough, reasons across the entire knowledge graph\n"
|
||||
"- hybrid: balanced, combines local and global (recommended)\n\n"
|
||||
"If the index is empty, the tool will report that and you should "
|
||||
"call lightrag_index() to populate it."
|
||||
),
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"query": {
|
||||
"type": "string",
|
||||
"description": "The question or search query.",
|
||||
},
|
||||
"mode": {
|
||||
"type": "string",
|
||||
"enum": ["local", "global", "hybrid"],
|
||||
"description": "Search mode. hybrid is recommended.",
|
||||
},
|
||||
},
|
||||
"required": ["query"],
|
||||
},
|
||||
}
|
||||
|
||||
LIGHTRAG_INDEX_SCHEMA = {
|
||||
"name": "lightrag_index",
|
||||
"description": (
|
||||
"(Re-)build the LightRAG knowledge graph from skill files and docs.\n\n"
|
||||
"By default indexes ~/.hermes/skills/. Pass extra directories if needed.\n"
|
||||
"This is a one-time or occasional operation; queries work against the "
|
||||
"existing index until you re-index."
|
||||
),
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"directories": {
|
||||
"type": "array",
|
||||
"items": {"type": "string"},
|
||||
"description": "Optional extra directories to index (in addition to ~/.hermes/skills/).",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Availability check
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def check_lightrag_requirements() -> bool:
|
||||
"""Return True if LightRAG and Ollama appear to be available."""
|
||||
try:
|
||||
import lightrag # noqa: F401
|
||||
except ImportError:
|
||||
return False
|
||||
return _ollama_available()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Registry
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
registry.register(
|
||||
name="lightrag_query",
|
||||
toolset="rag",
|
||||
schema=LIGHTRAG_QUERY_SCHEMA,
|
||||
handler=lambda args, **kw: lightrag_query(
|
||||
query=args.get("query", ""),
|
||||
mode=args.get("mode", "hybrid"),
|
||||
),
|
||||
check_fn=check_lightrag_requirements,
|
||||
emoji="🔎",
|
||||
)
|
||||
|
||||
registry.register(
|
||||
name="lightrag_index",
|
||||
toolset="rag",
|
||||
schema=LIGHTRAG_INDEX_SCHEMA,
|
||||
handler=lambda args, **kw: lightrag_index(
|
||||
directories=args.get("directories"),
|
||||
),
|
||||
check_fn=check_lightrag_requirements,
|
||||
emoji="📚",
|
||||
)
|
||||
@@ -322,112 +322,12 @@ def _cleanup_old_backups(file_path: Path, max_backups: int = MAX_BACKUPS_PER_FIL
|
||||
break
|
||||
|
||||
|
||||
|
||||
|
||||
# History registry for rollback (#837)
|
||||
MAX_HISTORY_VERSIONS = 3
|
||||
|
||||
|
||||
def _history_dir_for_skill(skill_name: str) -> Path:
|
||||
"""Return the history directory path for a skill."""
|
||||
return SKILLS_DIR / ".history" / skill_name
|
||||
|
||||
|
||||
def _save_to_history(skill_name: str, content: str, timestamp: Optional[int] = None) -> Optional[Path]:
|
||||
"""Save a version of the skill to the history registry.
|
||||
|
||||
History is stored in ~/.hermes/skills/.history/<skill-name>/<timestamp>.md
|
||||
Keeps the last MAX_HISTORY_VERSIONS versions.
|
||||
|
||||
Returns the path to the saved history file, or None if not saved.
|
||||
"""
|
||||
if timestamp is None:
|
||||
timestamp = int(time.time())
|
||||
|
||||
history_dir = _history_dir_for_skill(skill_name)
|
||||
history_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
history_file = history_dir / f"{timestamp}.md"
|
||||
_atomic_write_text(history_file, content)
|
||||
|
||||
# Clean up old history versions
|
||||
_cleanup_history(skill_name)
|
||||
|
||||
return history_file
|
||||
|
||||
|
||||
def _cleanup_history(skill_name: str, max_versions: int = MAX_HISTORY_VERSIONS) -> None:
|
||||
"""Prune old history versions, keeping only the most recent max_versions."""
|
||||
history_dir = _history_dir_for_skill(skill_name)
|
||||
if not history_dir.exists():
|
||||
return
|
||||
|
||||
try:
|
||||
# Get all history files sorted by modification time (oldest first)
|
||||
history_files = sorted(
|
||||
[f for f in history_dir.iterdir() if f.suffix == '.md' and f.is_file()],
|
||||
key=lambda p: p.stat().st_mtime,
|
||||
)
|
||||
except OSError:
|
||||
return
|
||||
|
||||
# Remove oldest files if we have more than max_versions
|
||||
while len(history_files) > max_versions:
|
||||
try:
|
||||
history_files.pop(0).unlink()
|
||||
except OSError:
|
||||
break
|
||||
|
||||
|
||||
def _get_history_versions(skill_name: str) -> List[Path]:
|
||||
"""Get list of history versions for a skill, newest first."""
|
||||
history_dir = _history_dir_for_skill(skill_name)
|
||||
if not history_dir.exists():
|
||||
return []
|
||||
|
||||
try:
|
||||
return sorted(
|
||||
[f for f in history_dir.iterdir() if f.suffix == '.md' and f.is_file()],
|
||||
key=lambda p: p.stat().st_mtime,
|
||||
reverse=True,
|
||||
)
|
||||
except OSError:
|
||||
return []
|
||||
|
||||
|
||||
def _revert_to_history(skill_name: str, skill_md_path: Path, version: int = 0) -> Optional[str]:
|
||||
"""Revert a skill to a previous history version.
|
||||
|
||||
Args:
|
||||
skill_name: Name of the skill
|
||||
skill_md_path: Path to the current SKILL.md
|
||||
version: Which history version to revert to (0 = most recent, 1 = second most recent, etc.)
|
||||
|
||||
Returns:
|
||||
Error message if revert failed, None if successful
|
||||
"""
|
||||
history_versions = _get_history_versions(skill_name)
|
||||
if not history_versions:
|
||||
return "No history versions available to revert to."
|
||||
|
||||
if version >= len(history_versions):
|
||||
return f"History version {version} not found (only {len(history_versions)} versions available)."
|
||||
|
||||
target_version = history_versions[version]
|
||||
|
||||
try:
|
||||
content = target_version.read_text(encoding="utf-8")
|
||||
_atomic_write_text(skill_md_path, content)
|
||||
return None
|
||||
except Exception as exc:
|
||||
return f"Failed to revert to history version: {exc}"
|
||||
|
||||
def _validate_written_file(file_path: Path, is_skill_md: bool = False) -> Optional[str]:
|
||||
"""Re-read a file from disk and validate it after writing.
|
||||
|
||||
Catches filesystem-level issues (truncation, encoding errors, empty
|
||||
writes) that pre-write validation cannot detect. For SKILL.md files
|
||||
the frontmatter is also re-validated and linked_files are verified.
|
||||
the frontmatter is also re-validated.
|
||||
|
||||
Returns an error message, or *None* if the file looks healthy.
|
||||
"""
|
||||
@@ -441,69 +341,11 @@ def _validate_written_file(file_path: Path, is_skill_md: bool = False) -> Option
|
||||
if len(content) == 0:
|
||||
return "File is empty after write (possible truncation)."
|
||||
|
||||
# Minimum content length check for SKILL.md only (#837)
|
||||
if is_skill_md and len(content) < 100:
|
||||
return f"SKILL.md is too short after write ({len(content)} chars, minimum 100)."
|
||||
|
||||
if is_skill_md:
|
||||
err = _validate_frontmatter(content)
|
||||
if err:
|
||||
return f"Post-write validation failed: {err}"
|
||||
|
||||
# Verify linked_files exist (#837)
|
||||
err = _validate_linked_files(content, file_path.parent)
|
||||
if err:
|
||||
return f"Post-write validation failed: {err}"
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def _validate_linked_files(content: str, skill_dir: Path) -> Optional[str]:
|
||||
"""Validate that all files referenced in linked_files exist.
|
||||
|
||||
Parses the SKILL.md frontmatter and checks that any linked_files
|
||||
entries point to files that actually exist in the skill directory.
|
||||
|
||||
Returns an error message, or *None* if all linked files exist.
|
||||
"""
|
||||
if not content.startswith("---"):
|
||||
return None
|
||||
|
||||
end_match = re.search(r'\n---\s*\n', content[3:])
|
||||
if not end_match:
|
||||
return None
|
||||
|
||||
yaml_content = content[3:end_match.start() + 3]
|
||||
try:
|
||||
parsed = yaml.safe_load(yaml_content)
|
||||
except yaml.YAMLError:
|
||||
return None
|
||||
|
||||
if not isinstance(parsed, dict):
|
||||
return None
|
||||
|
||||
linked_files = parsed.get("linked_files", [])
|
||||
if not linked_files:
|
||||
return None
|
||||
|
||||
missing = []
|
||||
for lf in linked_files:
|
||||
if isinstance(lf, dict):
|
||||
file_ref = lf.get("file") or lf.get("path", "")
|
||||
elif isinstance(lf, str):
|
||||
file_ref = lf
|
||||
else:
|
||||
continue
|
||||
|
||||
if file_ref:
|
||||
# Resolve relative to skill directory
|
||||
target = skill_dir / file_ref
|
||||
if not target.exists():
|
||||
missing.append(file_ref)
|
||||
|
||||
if missing:
|
||||
return f"Linked files missing: {', '.join(missing)}"
|
||||
|
||||
return None
|
||||
|
||||
|
||||
@@ -641,13 +483,6 @@ def _edit_skill(name: str, content: str) -> Dict[str, Any]:
|
||||
|
||||
skill_md = existing["path"] / "SKILL.md"
|
||||
|
||||
# Save original to history before modification (#837)
|
||||
try:
|
||||
original_content = skill_md.read_text(encoding="utf-8")
|
||||
_save_to_history(name, original_content)
|
||||
except (OSError, UnicodeDecodeError):
|
||||
pass # If we can't read original, proceed without history
|
||||
|
||||
# --- Transactional write-validate-commit-or-rollback ---
|
||||
backup_path = _backup_skill_file(skill_md)
|
||||
_atomic_write_text(skill_md, content)
|
||||
@@ -763,14 +598,6 @@ def _patch_skill(
|
||||
|
||||
is_skill_md = not file_path
|
||||
|
||||
# Save original to history when patching SKILL.md (#837)
|
||||
if is_skill_md:
|
||||
try:
|
||||
original_content = target.read_text(encoding="utf-8")
|
||||
_save_to_history(name, original_content)
|
||||
except (OSError, UnicodeDecodeError):
|
||||
pass
|
||||
|
||||
# --- Transactional write-validate-commit-or-rollback ---
|
||||
backup_path = _backup_skill_file(target)
|
||||
_atomic_write_text(target, new_content)
|
||||
|
||||
@@ -167,6 +167,12 @@ TOOLSETS = {
|
||||
"tools": ["memory"],
|
||||
"includes": []
|
||||
},
|
||||
|
||||
"rag": {
|
||||
"description": "Graph-based knowledge retrieval over indexed skills and docs (LightRAG)",
|
||||
"tools": ["lightrag_query", "lightrag_index"],
|
||||
"includes": []
|
||||
},
|
||||
|
||||
"session_search": {
|
||||
"description": "Search and recall past conversations with summarization",
|
||||
|
||||
Reference in New Issue
Block a user