Compare commits
2 Commits
whip/251-1
...
fix/626-va
| Author | SHA1 | Date | |
|---|---|---|---|
|
7664dbb9ef | ||
|
|
d9b891bef4 |
@@ -234,7 +234,12 @@ class HolographicMemoryProvider(MemoryProvider):
|
||||
return self._handle_fact_feedback(args)
|
||||
return json.dumps({"error": f"Unknown tool: {tool_name}"})
|
||||
|
||||
|
||||
def on_session_end(self, messages: List[Dict[str, Any]]) -> None:
|
||||
if not self._config.get("auto_extract", False):
|
||||
return
|
||||
if not self._store or not messages:
|
||||
return
|
||||
self._auto_extract_facts(messages)
|
||||
|
||||
def on_memory_write(self, action: str, target: str, content: str) -> None:
|
||||
"""Mirror built-in memory writes as facts.
|
||||
@@ -261,44 +266,6 @@ class HolographicMemoryProvider(MemoryProvider):
|
||||
except Exception as e:
|
||||
logger.debug("Holographic memory_write mirror failed: %s", e)
|
||||
|
||||
def on_session_end(self, messages: List[Dict[str, Any]]) -> None:
|
||||
"""Run auto-extraction and periodic contradiction detection."""
|
||||
if self._config.get("auto_extract", False):
|
||||
self._auto_extract_facts(messages)
|
||||
|
||||
# Periodic contradiction detection (run every ~50 sessions or on first session)
|
||||
self._maybe_run_contradiction_scan()
|
||||
|
||||
def _maybe_run_contradiction_scan(self) -> None:
|
||||
"""Run contradiction detection if enough sessions have passed since last run."""
|
||||
if not self._store or not self._retriever:
|
||||
return
|
||||
try:
|
||||
# Use a counter file to track sessions since last scan
|
||||
from hermes_constants import get_hermes_home
|
||||
counter_path = get_hermes_home() / ".contradiction_scan_counter"
|
||||
|
||||
count = 0
|
||||
if counter_path.exists():
|
||||
try:
|
||||
count = int(counter_path.read_text().strip())
|
||||
except (ValueError, OSError):
|
||||
count = 0
|
||||
|
||||
count += 1
|
||||
counter_path.write_text(str(count))
|
||||
|
||||
# Run every 50 sessions
|
||||
if count >= 50:
|
||||
counter_path.write_text("0")
|
||||
from .resolver import ContradictionResolver
|
||||
resolver = ContradictionResolver(self._store, self._retriever)
|
||||
report = resolver.run_detection_and_resolution(limit=50, auto_resolve=True)
|
||||
if report.contradictions_found > 0:
|
||||
logger.info("Periodic contradiction scan: %s", report.summary())
|
||||
except Exception as e:
|
||||
logger.debug("Periodic contradiction scan failed: %s", e)
|
||||
|
||||
def shutdown(self) -> None:
|
||||
self._store = None
|
||||
self._retriever = None
|
||||
|
||||
@@ -1,179 +0,0 @@
|
||||
"""Contradiction detection and resolution for holographic memory.
|
||||
|
||||
Periodically scans the fact store for contradictions using the retriever's
|
||||
contradict() method, then resolves obvious cases and flags ambiguous ones.
|
||||
|
||||
Resolution strategy:
|
||||
- Obvious: same entity, newer fact supersedes older → lower trust on older
|
||||
- Ambiguous: different claims about same entity → flag for review, don't auto-resolve
|
||||
- High-confidence contradiction (>0.7 score): lower trust on both, log warning
|
||||
|
||||
Usage:
|
||||
from plugins.memory.holographic.resolver import ContradictionResolver
|
||||
resolver = ContradictionResolver(store, retriever)
|
||||
report = resolver.run_detection_and_resolution()
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
from datetime import datetime
|
||||
from typing import Any, Dict, List, Optional
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
# Thresholds
|
||||
_OBVIOUS_THRESHOLD = 0.5 # contradiction_score >= this → obvious
|
||||
_AMBIGUOUS_THRESHOLD = 0.3 # contradiction_score >= this → flag
|
||||
_HIGH_CONFIDENCE = 0.7 # contradiction_score >= this → high confidence
|
||||
_TRUST_PENALTY_OLD = 0.3 # trust reduction for superseded fact
|
||||
_TRUST_PENALTY_CONFLICT = 0.15 # trust reduction for ambiguous conflicts
|
||||
|
||||
|
||||
class ContradictionReport:
|
||||
"""Results of a contradiction detection and resolution run."""
|
||||
|
||||
def __init__(self):
|
||||
self.total_scanned: int = 0
|
||||
self.contradictions_found: int = 0
|
||||
self.auto_resolved: int = 0
|
||||
self.flagged_for_review: int = 0
|
||||
self.high_confidence: int = 0
|
||||
self.resolved_pairs: List[Dict[str, Any]] = []
|
||||
self.flagged_pairs: List[Dict[str, Any]] = []
|
||||
|
||||
def summary(self) -> str:
|
||||
lines = [
|
||||
f"Contradiction scan: {self.total_scanned} facts, "
|
||||
f"{self.contradictions_found} contradictions found",
|
||||
f" Auto-resolved: {self.auto_resolved} (newer supersedes older)",
|
||||
f" High-confidence: {self.high_confidence} (trust lowered on both)",
|
||||
f" Flagged for review: {self.flagged_for_review}",
|
||||
]
|
||||
for pair in self.flagged_pairs[:5]:
|
||||
lines.append(
|
||||
f" [REVIEW] score={pair['contradiction_score']:.2f} "
|
||||
f"entities={pair['shared_entities']} "
|
||||
f"A: {pair['fact_a']['content'][:50]}… "
|
||||
f"B: {pair['fact_b']['content'][:50]}…"
|
||||
)
|
||||
return "\n".join(lines)
|
||||
|
||||
def to_dict(self) -> dict:
|
||||
return {
|
||||
"total_scanned": self.total_scanned,
|
||||
"contradictions_found": self.contradictions_found,
|
||||
"auto_resolved": self.auto_resolved,
|
||||
"high_confidence": self.high_confidence,
|
||||
"flagged_for_review": self.flagged_for_review,
|
||||
"resolved_pairs": self.resolved_pairs,
|
||||
"flagged_pairs": self.flagged_pairs,
|
||||
}
|
||||
|
||||
|
||||
class ContradictionResolver:
|
||||
"""Detects and resolves contradictions in the holographic fact store."""
|
||||
|
||||
def __init__(self, store, retriever):
|
||||
self._store = store
|
||||
self._retriever = retriever
|
||||
|
||||
def run_detection_and_resolution(
|
||||
self,
|
||||
limit: int = 50,
|
||||
auto_resolve: bool = True,
|
||||
) -> ContradictionReport:
|
||||
"""Run a full contradiction detection and resolution pass.
|
||||
|
||||
Args:
|
||||
limit: Max contradiction pairs to process.
|
||||
auto_resolve: If True, auto-resolve obvious cases.
|
||||
|
||||
Returns:
|
||||
ContradictionReport with all findings and actions taken.
|
||||
"""
|
||||
report = ContradictionReport()
|
||||
|
||||
try:
|
||||
contradictions = self._retriever.contradict(limit=limit)
|
||||
except Exception as e:
|
||||
logger.warning("Contradiction detection failed: %s", e)
|
||||
return report
|
||||
|
||||
report.total_scanned = len(contradictions)
|
||||
report.contradictions_found = len(contradictions)
|
||||
|
||||
for pair in contradictions:
|
||||
score = pair.get("contradiction_score", 0.0)
|
||||
|
||||
if score >= _HIGH_CONFIDENCE:
|
||||
report.high_confidence += 1
|
||||
if auto_resolve:
|
||||
self._resolve_high_confidence(pair, report)
|
||||
elif score >= _OBVIOUS_THRESHOLD:
|
||||
if auto_resolve:
|
||||
self._resolve_obvious(pair, report)
|
||||
elif score >= _AMBIGUOUS_THRESHOLD:
|
||||
report.flagged_for_review += 1
|
||||
report.flagged_pairs.append(pair)
|
||||
# Lower trust slightly on both to reduce retrieval weight
|
||||
self._penalize_both(pair, _TRUST_PENALTY_CONFLICT)
|
||||
|
||||
return report
|
||||
|
||||
def _resolve_obvious(self, pair: dict, report: ContradictionReport) -> None:
|
||||
"""Resolve obvious contradiction: newer fact supersedes older.
|
||||
|
||||
Same entity, clearly contradictory claims. Newer wins.
|
||||
"""
|
||||
fact_a = pair["fact_a"]
|
||||
fact_b = pair["fact_b"]
|
||||
|
||||
# Determine which is newer
|
||||
a_time = fact_a.get("updated_at") or fact_a.get("created_at", "")
|
||||
b_time = fact_b.get("updated_at") or fact_b.get("created_at", "")
|
||||
|
||||
if a_time >= b_time:
|
||||
newer, older = fact_a, fact_b
|
||||
else:
|
||||
newer, older = fact_b, fact_a
|
||||
|
||||
# Lower trust on the older (superseded) fact
|
||||
try:
|
||||
self._store.update_fact(
|
||||
older["fact_id"],
|
||||
trust_delta=-_TRUST_PENALTY_OLD,
|
||||
)
|
||||
report.auto_resolved += 1
|
||||
report.resolved_pairs.append({
|
||||
"action": "superseded",
|
||||
"kept": newer["fact_id"],
|
||||
"demoted": older["fact_id"],
|
||||
"reason": f"Newer fact supersedes older (score={pair['contradiction_score']:.2f})",
|
||||
})
|
||||
logger.info(
|
||||
"Contradiction resolved: fact#%d supersedes fact#%d (entities: %s)",
|
||||
newer["fact_id"], older["fact_id"],
|
||||
pair.get("shared_entities", []),
|
||||
)
|
||||
except Exception as e:
|
||||
logger.debug("Failed to resolve contradiction: %s", e)
|
||||
|
||||
def _resolve_high_confidence(self, pair: dict, report: ContradictionReport) -> None:
|
||||
"""Resolve high-confidence contradiction: lower trust on both facts.
|
||||
|
||||
We can't determine which is correct, so both get penalized.
|
||||
"""
|
||||
self._penalize_both(pair, _TRUST_PENALTY_CONFLICT * 2)
|
||||
report.flagged_pairs.append(pair)
|
||||
|
||||
def _penalize_both(self, pair: dict, penalty: float) -> None:
|
||||
"""Lower trust on both contradictory facts."""
|
||||
for key in ("fact_a", "fact_b"):
|
||||
fact = pair.get(key, {})
|
||||
fid = fact.get("fact_id")
|
||||
if fid:
|
||||
try:
|
||||
self._store.update_fact(fid, trust_delta=-penalty)
|
||||
except Exception as e:
|
||||
logger.debug("Failed to penalize fact#%d: %s", fid, e)
|
||||
@@ -245,6 +245,269 @@ def _validate_file_path(file_path: str) -> Optional[str]:
|
||||
return None
|
||||
|
||||
|
||||
def _validate_skill(name: str) -> Dict[str, Any]:
|
||||
"""
|
||||
Validate an existing skill and provide actionable feedback.
|
||||
|
||||
Checks:
|
||||
1. Skill exists
|
||||
2. SKILL.md frontmatter (name, description, valid YAML)
|
||||
3. Content structure (body after frontmatter)
|
||||
4. Content size limits
|
||||
5. Linked files (references/, templates/, scripts/) exist
|
||||
6. Naming conventions
|
||||
|
||||
Returns dict with success, issues (list of {check, status, message, fix}),
|
||||
and summary.
|
||||
"""
|
||||
issues = []
|
||||
warnings = []
|
||||
|
||||
# Check 1: Does the skill exist?
|
||||
skill_info = _find_skill(name)
|
||||
if not skill_info:
|
||||
# Try to find similar names for the suggestion
|
||||
from agent.skill_utils import get_all_skills_dirs
|
||||
all_names = []
|
||||
for skills_dir in get_all_skills_dirs():
|
||||
if skills_dir.exists():
|
||||
for md in skills_dir.rglob("SKILL.md"):
|
||||
all_names.append(md.parent.name)
|
||||
suggestion = ""
|
||||
if all_names:
|
||||
import difflib
|
||||
close = difflib.get_close_matches(name, all_names, n=3, cutoff=0.6)
|
||||
if close:
|
||||
suggestion = f" Did you mean: {', '.join(close)}?"
|
||||
|
||||
return {
|
||||
"success": False,
|
||||
"valid": False,
|
||||
"issues": [{"check": "existence", "status": "FAIL",
|
||||
"message": f"Skill '{name}' not found.{suggestion}",
|
||||
"fix": f"Create it with: skill_manage(action='create', name='{name}', content='...')"}],
|
||||
"summary": f"Skill '{name}' does not exist."
|
||||
}
|
||||
|
||||
skill_dir = skill_info["path"]
|
||||
skill_md = skill_dir / "SKILL.md"
|
||||
|
||||
# Check 2: SKILL.md exists
|
||||
if not skill_md.exists():
|
||||
issues.append({
|
||||
"check": "SKILL.md exists",
|
||||
"status": "FAIL",
|
||||
"message": f"No SKILL.md found in {skill_dir}",
|
||||
"fix": f"Create SKILL.md with: skill_manage(action='create', name='{name}', content='---\\nname: {name}\\ndescription: ...\\n---\\n# Instructions\\n...')"
|
||||
})
|
||||
return {"success": True, "valid": False, "issues": issues, "summary": f"Skill '{name}' is missing SKILL.md."}
|
||||
|
||||
# Read content
|
||||
try:
|
||||
content = skill_md.read_text(encoding="utf-8")
|
||||
except Exception as e:
|
||||
issues.append({
|
||||
"check": "SKILL.md readable",
|
||||
"status": "FAIL",
|
||||
"message": f"Cannot read SKILL.md: {e}",
|
||||
"fix": "Check file permissions: chmod 644 SKILL.md"
|
||||
})
|
||||
return {"success": True, "valid": False, "issues": issues, "summary": f"Cannot read SKILL.md."}
|
||||
|
||||
# Check 3: Content not empty
|
||||
if not content.strip():
|
||||
issues.append({
|
||||
"check": "content non-empty",
|
||||
"status": "FAIL",
|
||||
"message": "SKILL.md is empty.",
|
||||
"fix": f"Add content with: skill_manage(action='edit', name='{name}', content='---\\nname: {name}\\ndescription: ...\\n---\\n# Instructions\\n...')"
|
||||
})
|
||||
return {"success": True, "valid": False, "issues": issues, "summary": "SKILL.md is empty."}
|
||||
|
||||
# Check 4: Frontmatter starts with ---
|
||||
if not content.startswith("---"):
|
||||
issues.append({
|
||||
"check": "frontmatter delimiter",
|
||||
"status": "FAIL",
|
||||
"message": "SKILL.md must start with YAML frontmatter (---).",
|
||||
"fix": "Add '---' as the first line, then YAML metadata, then '---' to close.\n"
|
||||
"Example:\n---\nname: my-skill\ndescription: What this skill does\n---\n# Instructions\n..."
|
||||
})
|
||||
else:
|
||||
# Check 5: Frontmatter closes
|
||||
end_match = re.search(r'\n---\s*\n', content[3:])
|
||||
if not end_match:
|
||||
issues.append({
|
||||
"check": "frontmatter closing",
|
||||
"status": "FAIL",
|
||||
"message": "Frontmatter is not closed with '---'.",
|
||||
"fix": "Add a line with just '---' after your YAML metadata to close the frontmatter block."
|
||||
})
|
||||
else:
|
||||
# Check 6: Valid YAML
|
||||
yaml_content = content[3:end_match.start() + 3]
|
||||
try:
|
||||
parsed = yaml.safe_load(yaml_content)
|
||||
except yaml.YAMLError as e:
|
||||
issues.append({
|
||||
"check": "YAML valid",
|
||||
"status": "FAIL",
|
||||
"message": f"YAML parse error: {e}",
|
||||
"fix": "Fix the YAML syntax in your frontmatter. Common issues:\n"
|
||||
" - Missing quotes around values with special chars (:, {, }, [, ])\n"
|
||||
" - Inconsistent indentation (use spaces, not tabs)\n"
|
||||
" - Unescaped colons in descriptions"
|
||||
})
|
||||
parsed = None
|
||||
|
||||
if parsed and isinstance(parsed, dict):
|
||||
# Check 7: name field
|
||||
if "name" not in parsed:
|
||||
issues.append({
|
||||
"check": "frontmatter name",
|
||||
"status": "FAIL",
|
||||
"message": "Frontmatter missing 'name' field.",
|
||||
"fix": f"Add 'name: {name}' to your frontmatter YAML."
|
||||
})
|
||||
elif parsed["name"] != name:
|
||||
warnings.append({
|
||||
"check": "frontmatter name match",
|
||||
"status": "WARN",
|
||||
"message": f"Frontmatter name '{parsed['name']}' doesn't match directory name '{name}'.",
|
||||
"fix": "Change 'name: " + str(parsed.get("name", "")) + "' to 'name: " + name + "' in frontmatter, or rename the directory to match."
|
||||
})
|
||||
|
||||
# Check 8: description field
|
||||
if "description" not in parsed:
|
||||
issues.append({
|
||||
"check": "frontmatter description",
|
||||
"status": "FAIL",
|
||||
"message": "Frontmatter missing 'description' field.",
|
||||
"fix": "Add 'description: A brief description of what this skill does' to frontmatter. "
|
||||
f"Max {MAX_DESCRIPTION_LENGTH} characters."
|
||||
})
|
||||
elif len(str(parsed["description"])) > MAX_DESCRIPTION_LENGTH:
|
||||
issues.append({
|
||||
"check": "description length",
|
||||
"status": "FAIL",
|
||||
"message": f"Description is {len(str(parsed['description']))} chars (max {MAX_DESCRIPTION_LENGTH}).",
|
||||
"fix": f"Shorten the description to under {MAX_DESCRIPTION_LENGTH} characters. "
|
||||
"Put detailed instructions in the body, not the description."
|
||||
})
|
||||
|
||||
elif parsed and not isinstance(parsed, dict):
|
||||
issues.append({
|
||||
"check": "frontmatter structure",
|
||||
"status": "FAIL",
|
||||
"message": "Frontmatter must be a YAML mapping (key: value pairs).",
|
||||
"fix": "Ensure frontmatter contains key-value pairs like:\nname: my-skill\ndescription: What it does"
|
||||
})
|
||||
|
||||
# Check 9: Body content after frontmatter
|
||||
if end_match:
|
||||
body = content[end_match.end() + 3:].strip()
|
||||
if not body:
|
||||
issues.append({
|
||||
"check": "body content",
|
||||
"status": "FAIL",
|
||||
"message": "No content after frontmatter.",
|
||||
"fix": "Add instructions, steps, or reference content after the closing '---'. "
|
||||
"Skills need a body to be useful — at minimum a description of when to use the skill."
|
||||
})
|
||||
elif len(body) < 20:
|
||||
warnings.append({
|
||||
"check": "body content size",
|
||||
"status": "WARN",
|
||||
"message": f"Body content is very short ({len(body)} chars).",
|
||||
"fix": "Add more detail: numbered steps, examples, pitfalls to avoid, "
|
||||
"or reference files in references/ or templates/."
|
||||
})
|
||||
|
||||
# Check 10: Content size
|
||||
if len(content) > MAX_SKILL_CONTENT_CHARS:
|
||||
issues.append({
|
||||
"check": "content size",
|
||||
"status": "FAIL",
|
||||
"message": f"SKILL.md is {len(content):,} chars (max {MAX_SKILL_CONTENT_CHARS:,}).",
|
||||
"fix": f"Split into a shorter SKILL.md (core instructions) with detailed content in:\n"
|
||||
f" - references/detailed-guide.md\n"
|
||||
f" - templates/example.yaml\n"
|
||||
f" - scripts/validate.py\n"
|
||||
f"Use skill_manage(action='write_file') to add linked files."
|
||||
})
|
||||
elif len(content) > MAX_SKILL_CONTENT_CHARS * 0.8:
|
||||
warnings.append({
|
||||
"check": "content size warning",
|
||||
"status": "WARN",
|
||||
"message": f"SKILL.md is {len(content):,} chars ({len(content) * 100 // MAX_SKILL_CONTENT_CHARS}% of limit).",
|
||||
"fix": "Consider moving detailed content to references/ or templates/ files."
|
||||
})
|
||||
|
||||
# Check 11: Linked files exist
|
||||
for subdir in ["references", "templates", "scripts"]:
|
||||
subdir_path = skill_dir / subdir
|
||||
if subdir_path.exists():
|
||||
for linked_file in subdir_path.rglob("*"):
|
||||
if linked_file.is_file():
|
||||
try:
|
||||
linked_file.read_text(encoding="utf-8")
|
||||
except Exception as e:
|
||||
warnings.append({
|
||||
"check": f"linked file {subdir}/{linked_file.name}",
|
||||
"status": "WARN",
|
||||
"message": f"Cannot read {linked_file.relative_to(skill_dir)}: {e}",
|
||||
"fix": f"Check file exists and has read permissions."
|
||||
})
|
||||
|
||||
# Check 12: Naming convention
|
||||
if not VALID_NAME_RE.match(name):
|
||||
warnings.append({
|
||||
"check": "naming convention",
|
||||
"status": "WARN",
|
||||
"message": f"Skill name '{name}' doesn't follow convention (lowercase, hyphens, underscores).",
|
||||
"fix": "Rename to use lowercase letters, numbers, hyphens, dots, and underscores only. "
|
||||
"Must start with a letter or digit."
|
||||
})
|
||||
|
||||
# Check 13: Orphaned files (files not in allowed subdirs)
|
||||
if skill_dir.exists():
|
||||
for item in skill_dir.iterdir():
|
||||
if item.name == "SKILL.md":
|
||||
continue
|
||||
if item.name.startswith("."):
|
||||
continue
|
||||
if item.is_dir() and item.name in ALLOWED_SUBDIRS:
|
||||
continue
|
||||
warnings.append({
|
||||
"check": "file organization",
|
||||
"status": "WARN",
|
||||
"message": f"'{item.name}' is in the skill root, not in an allowed subdirectory.",
|
||||
"fix": f"Move to references/, templates/, or scripts/. Allowed subdirs: {', '.join(sorted(ALLOWED_SUBDIRS))}"
|
||||
})
|
||||
|
||||
# Build summary
|
||||
fail_count = sum(1 for i in issues if i["status"] == "FAIL")
|
||||
warn_count = len(warnings)
|
||||
valid = fail_count == 0
|
||||
|
||||
if valid and warn_count == 0:
|
||||
summary = f"Skill '{name}' is valid. No issues found."
|
||||
elif valid:
|
||||
summary = f"Skill '{name}' is valid with {warn_count} warning(s)."
|
||||
else:
|
||||
summary = f"Skill '{name}' has {fail_count} issue(s) and {warn_count} warning(s)."
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"valid": valid,
|
||||
"issues": issues,
|
||||
"warnings": warnings,
|
||||
"summary": summary,
|
||||
"skill_path": str(skill_dir),
|
||||
"skill_md_size": len(content),
|
||||
}
|
||||
|
||||
|
||||
def _atomic_write_text(file_path: Path, content: str, encoding: str = "utf-8") -> None:
|
||||
"""
|
||||
Atomically write text content to a file.
|
||||
@@ -567,6 +830,257 @@ def _remove_file(name: str, file_path: str) -> Dict[str, Any]:
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
def _validate_skill(name: str) -> Dict[str, Any]:
|
||||
"""Validate a skill and provide actionable feedback with specific remediation steps.
|
||||
|
||||
Returns detailed validation results with:
|
||||
- Specific issues found
|
||||
- Actionable suggestions for each issue
|
||||
- Examples of correct formatting
|
||||
- Overall pass/fail status
|
||||
"""
|
||||
existing = _find_skill(name)
|
||||
if not existing:
|
||||
return {
|
||||
"success": False,
|
||||
"error": f"Skill '{name}' not found.",
|
||||
"suggestion": f"Use skill_manage(action='create', name='{name}', content='...') to create it.",
|
||||
}
|
||||
|
||||
skill_dir = existing["path"]
|
||||
skill_md = skill_dir / "SKILL.md"
|
||||
|
||||
issues = []
|
||||
warnings = []
|
||||
suggestions = []
|
||||
|
||||
# 1. Check SKILL.md exists
|
||||
if not skill_md.exists():
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "SKILL.md exists",
|
||||
"message": "SKILL.md file is missing.",
|
||||
"remediation": f"Create SKILL.md in {skill_dir}/ with YAML frontmatter and instructions.",
|
||||
"example": """---
|
||||
name: my-skill
|
||||
description: "What this skill does in one sentence."
|
||||
---
|
||||
|
||||
## When to Use
|
||||
- Trigger condition 1
|
||||
- Trigger condition 2
|
||||
|
||||
## Steps
|
||||
1. First step with exact command
|
||||
2. Second step
|
||||
|
||||
## Pitfalls
|
||||
- Common mistake and how to avoid it
|
||||
""",
|
||||
})
|
||||
return {"success": False, "name": name, "path": str(skill_dir), "issues": issues, "warnings": warnings, "suggestions": suggestions}
|
||||
|
||||
# Read content
|
||||
try:
|
||||
content_text = skill_md.read_text(encoding="utf-8")
|
||||
except Exception as e:
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "readable",
|
||||
"message": f"Cannot read SKILL.md: {e}",
|
||||
"remediation": "Check file permissions and encoding (should be UTF-8).",
|
||||
})
|
||||
return {"success": False, "name": name, "path": str(skill_dir), "issues": issues}
|
||||
|
||||
# 2. Check frontmatter
|
||||
if not content_text.strip().startswith("---"):
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "frontmatter present",
|
||||
"message": "SKILL.md does not start with YAML frontmatter delimiter (---).",
|
||||
"remediation": "Add '---' as the very first line of SKILL.md.",
|
||||
"example": "---\nname: my-skill\ndescription: "What it does."\n---",
|
||||
})
|
||||
else:
|
||||
# Parse frontmatter
|
||||
end_match = re.search(r'\n---\s*\n', content_text[3:])
|
||||
if not end_match:
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "frontmatter closed",
|
||||
"message": "YAML frontmatter is not closed with a second '---'.",
|
||||
"remediation": "Add a line with just '---' after your frontmatter fields.",
|
||||
})
|
||||
else:
|
||||
yaml_content = content_text[3:end_match.start() + 3]
|
||||
try:
|
||||
parsed = yaml.safe_load(yaml_content)
|
||||
except yaml.YAMLError as e:
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "frontmatter valid YAML",
|
||||
"message": f"YAML parse error: {e}",
|
||||
"remediation": "Fix YAML syntax in the frontmatter block.",
|
||||
"example": """---
|
||||
name: my-skill
|
||||
description: "A clear description."
|
||||
version: "1.0.0"
|
||||
---""",
|
||||
})
|
||||
parsed = None
|
||||
|
||||
if parsed and isinstance(parsed, dict):
|
||||
# Check required fields
|
||||
if "name" not in parsed:
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "name field",
|
||||
"message": "Frontmatter missing required 'name' field.",
|
||||
"remediation": f"Add: name: {name}",
|
||||
})
|
||||
elif parsed["name"] != name:
|
||||
warnings.append({
|
||||
"check": "name matches directory",
|
||||
"message": f"Frontmatter name '{parsed['name']}' doesn't match directory name '{name}'.",
|
||||
"suggestion": f"Consider changing to: name: {name}",
|
||||
})
|
||||
|
||||
if "description" not in parsed:
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "description field",
|
||||
"message": "Frontmatter missing required 'description' field.",
|
||||
"remediation": "Add a one-sentence description of what this skill does.",
|
||||
"example": 'description: "Deploy containerized services to production VPS."',
|
||||
})
|
||||
elif len(str(parsed.get("description", ""))) > MAX_DESCRIPTION_LENGTH:
|
||||
issues.append({
|
||||
"severity": "warning",
|
||||
"check": "description length",
|
||||
"message": f"Description is {len(str(parsed['description']))} chars (max {MAX_DESCRIPTION_LENGTH}).",
|
||||
"remediation": "Shorten the description to one clear sentence.",
|
||||
})
|
||||
|
||||
if "version" not in parsed:
|
||||
suggestions.append({
|
||||
"check": "version field",
|
||||
"message": "No version field in frontmatter.",
|
||||
"suggestion": "Add: version: "1.0.0" for tracking changes.",
|
||||
})
|
||||
elif parsed is not None:
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "frontmatter is mapping",
|
||||
"message": "Frontmatter must be a YAML mapping (key: value pairs).",
|
||||
"remediation": "Ensure frontmatter contains key: value pairs, not a list.",
|
||||
})
|
||||
|
||||
# 3. Check body content
|
||||
if end_match:
|
||||
body = content_text[end_match.end() + 3:].strip()
|
||||
if not body:
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "body content",
|
||||
"message": "SKILL.md has no content after frontmatter.",
|
||||
"remediation": "Add instructions, steps, or procedures after the frontmatter.",
|
||||
"example": """## When to Use
|
||||
- Condition that triggers this skill
|
||||
|
||||
## Steps
|
||||
1. First step
|
||||
2. Second step
|
||||
|
||||
## Pitfalls
|
||||
- Known issues and solutions""",
|
||||
})
|
||||
else:
|
||||
# Check for common sections
|
||||
if "## " not in body:
|
||||
warnings.append({
|
||||
"check": "structured sections",
|
||||
"message": "Body has no markdown headers (##).",
|
||||
"suggestion": "Add sections like '## Steps', '## Pitfalls' for better structure.",
|
||||
})
|
||||
|
||||
# Check body length
|
||||
if len(body) < 50:
|
||||
warnings.append({
|
||||
"check": "body length",
|
||||
"message": f"Body is very short ({len(body)} chars).",
|
||||
"suggestion": "Skills should have enough detail to reproduce the procedure.",
|
||||
})
|
||||
|
||||
# 4. Check content size
|
||||
if len(content_text) > MAX_SKILL_CONTENT_CHARS:
|
||||
issues.append({
|
||||
"severity": "warning",
|
||||
"check": "content size",
|
||||
"message": f"SKILL.md is {len(content_text):,} chars (limit: {MAX_SKILL_CONTENT_CHARS:,}).",
|
||||
"remediation": "Split large content into SKILL.md + supporting files in references/.",
|
||||
})
|
||||
|
||||
# 5. Check supporting files
|
||||
for subdir in ALLOWED_SUBDIRS:
|
||||
subdir_path = skill_dir / subdir
|
||||
if subdir_path.exists():
|
||||
for f in subdir_path.rglob("*"):
|
||||
if f.is_file():
|
||||
size = f.stat().st_size
|
||||
if size > MAX_SKILL_FILE_BYTES:
|
||||
issues.append({
|
||||
"severity": "warning",
|
||||
"check": "file size",
|
||||
"message": f"{f.relative_to(skill_dir)} is {size:,} bytes (limit: {MAX_SKILL_FILE_BYTES:,}).",
|
||||
"remediation": "Split into smaller files or compress.",
|
||||
})
|
||||
|
||||
# 6. Security scan
|
||||
if _GUARD_AVAILABLE:
|
||||
try:
|
||||
scan_result = scan_skill(skill_dir, source="validation")
|
||||
allowed, reason = should_allow_install(scan_result)
|
||||
if allowed is False:
|
||||
issues.append({
|
||||
"severity": "error",
|
||||
"check": "security scan",
|
||||
"message": f"Security scan blocked: {reason}",
|
||||
"remediation": "Review and fix security findings before using this skill.",
|
||||
})
|
||||
elif allowed is None:
|
||||
warnings.append({
|
||||
"check": "security scan",
|
||||
"message": f"Security findings: {reason}",
|
||||
"suggestion": "Review security findings. They may be intentional but worth checking.",
|
||||
})
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
# Build result
|
||||
is_valid = not any(i["severity"] == "error" for i in issues)
|
||||
|
||||
# Add general suggestions if valid but improvable
|
||||
if is_valid and not warnings and not suggestions:
|
||||
suggestions.append({
|
||||
"check": "overall",
|
||||
"message": "Skill passes all checks.",
|
||||
"suggestion": "Consider adding '## Pitfalls' section with known issues and solutions.",
|
||||
})
|
||||
|
||||
return {
|
||||
"success": True,
|
||||
"name": name,
|
||||
"path": str(skill_dir),
|
||||
"valid": is_valid,
|
||||
"issues": issues,
|
||||
"warnings": warnings,
|
||||
"suggestions": suggestions,
|
||||
"summary": f"{len(issues)} issue(s), {len(warnings)} warning(s), {len(suggestions)} suggestion(s)",
|
||||
}
|
||||
|
||||
|
||||
# =============================================================================
|
||||
# Main entry point
|
||||
# =============================================================================
|
||||
@@ -619,8 +1133,11 @@ def skill_manage(
|
||||
return json.dumps({"success": False, "error": "file_path is required for 'remove_file'."}, ensure_ascii=False)
|
||||
result = _remove_file(name, file_path)
|
||||
|
||||
elif action == "validate":
|
||||
result = _validate_skill(name)
|
||||
|
||||
else:
|
||||
result = {"success": False, "error": f"Unknown action '{action}'. Use: create, edit, patch, delete, write_file, remove_file"}
|
||||
result = {"success": False, "error": f"Unknown action '{action}'. Use: create, edit, patch, delete, write_file, remove_file, validate"}
|
||||
|
||||
if result.get("success"):
|
||||
try:
|
||||
@@ -642,10 +1159,10 @@ SKILL_MANAGE_SCHEMA = {
|
||||
"Manage skills (create, update, delete). Skills are your procedural "
|
||||
"memory — reusable approaches for recurring task types. "
|
||||
"New skills go to ~/.hermes/skills/; existing skills can be modified wherever they live.\n\n"
|
||||
"Actions: create (full SKILL.md + optional category), "
|
||||
"Actions: create (full SKILL.md + optional category), validate (check skill with actionable feedback), "
|
||||
"patch (old_string/new_string — preferred for fixes), "
|
||||
"edit (full SKILL.md rewrite — major overhauls only), "
|
||||
"delete, write_file, remove_file.\n\n"
|
||||
"delete, write_file, remove_file, validate (check skill with actionable feedback).\n\n"
|
||||
"Create when: complex task succeeded (5+ calls), errors overcome, "
|
||||
"user-corrected approach worked, non-trivial workflow discovered, "
|
||||
"or user asks you to remember a procedure.\n"
|
||||
@@ -662,7 +1179,7 @@ SKILL_MANAGE_SCHEMA = {
|
||||
"properties": {
|
||||
"action": {
|
||||
"type": "string",
|
||||
"enum": ["create", "patch", "edit", "delete", "write_file", "remove_file"],
|
||||
"enum": ["create", "patch", "edit", "delete", "write_file", "remove_file", "validate"],
|
||||
"description": "The action to perform."
|
||||
},
|
||||
"name": {
|
||||
|
||||
Reference in New Issue
Block a user