kb-memory
rag-kb — Lokaler Agent-Gedächtnisdienst + Multi-Agent-Kollaborationssystem
English | Deutsch
Dieses Repository enthält zwei Subsysteme (ROADMAP):
Subsystem | Kurzbeschreibung | Status |
kb | Lokaler, vollständig kostenloser Agent-Gedächtnis- und Wissensdienst (Kernprodukt, Hauptentwicklungslinie) | v1.0.1 produktionsreif |
agent-orchestra | Taskübergreifendes Multi-Agent-Kollaborationssystem auf Basis des gemeinsamen kb-Taskboards (❄️ Wartungsmodus, eigenes Gerüst) | B1-B3 eingefroren |
Open-Source-Lizenz: Apache-2.0 (inklusive Patentlizenz, kommerziell nutzbar).
kb — Local-First-Agent-Gedächtnis- und Wissensdienst
Windows-Einzelprozess-Dauerbetrieb (python -m kb serve), Doppelprotokoll REST + MCP; stellt Claude Code / Cursor / TraeWork / selbst erstellten Agents das Schreiben von Erinnerungen, das Aufnehmen von Dokumenten und Webseiten, hybride Suche (Vektor + BM25/RRF-Fusion) und RAG-Fragenbeantwortung bereit.
Ohne LLM sind Zugriff und Suche vollständig nutzbar – das Schreiben von Erinnerungen, die Dokumentaufnahme und die hybride Suche hängen von keinem großen Modell ab; nach Konfiguration von lokalem Ollama oder Cloud-API wird die /ask-Fragenbeantwortung automatisch aktiviert.
Related MCP server: mnemostack
Kernfunktionen
Dauerbetrieb im Einzelprozess: Ein
python -m kb servebietet gleichzeitig REST-API- und MCP-Endpunkte, ohne zusätzliche KomponentenHybride Suche: BGE-M3-Vektorsuche + BM25-Keywordsuche, RRF-Fusions-Ranking, chinesische Segmentierung freundlich
Optionale Neubewertung:
KB_RERANK_ENABLED=trueaktiviert bge-reranker-v2-m3-Cross-Encoder-Reranking (standardmäßig aus)Optionaler dritter Pfad:
KB_SPARSE_ENABLED=trueaktiviert den dritten BGE-M3-Sparse-Vektor-Pfad (standardmäßig aus, bei Fehlern automatischer Fallback auf zwei Pfade)
Erinnerungsverwaltung: Schreiben / Aktualisieren / Löschen / Auflisten, unterstützt Filterung nach namespace, tags, type
Multi-Client-/Projektisolierung (v2): Isolationsschlüssel =
(client, project), Identität wird von der Umgebung getragen, nicht von der KI selbst angegeben – client wird automatisch aus MCP clientInfo erkannt (auf Framework-Ebene vertrauenswürdig), project wird von Verbindung/Verzeichnis getragen (Standard = Standard-Bucket dieses Clients); persönliche Erinnerungen sind nur für diesen Client + dieses Projekt sichtbar (Lesen/Ändern/Löschen durch andere wird abgelehnt), geteiltes Dokument-/Webseitenwissen ist für alle Clients sichtbar; Primärschlüssel werden serverseitig generiertZugriffs-Audit: Jeder Schreib-/Lese-/Änderungs-/Lösch-/Such-/Fragevorgang wird als JSON in
logs/agent-audit/<客户端>__<项目>.loggeschrieben (nach client+project getrennte Dateien); Benutzer können abfragen: RESTGET /api/v1/audit?client=<客户端>[&project=<项目>]oder CLIkb audit --client <客户端>Wissensaufnahme: Lokale Dokumente (txt/md/pdf/docx usw.) per Upload oder Pfadimport, Webseiteninhalte werden extrahiert und aufgenommen
Verzeichnisüberwachung: Neu hinzugefügte oder gelöschte Dateien im angegebenen Verzeichnis werden automatisch aufgenommen/bereinigt (
KB_WATCH_DIR)CLI-Werkzeuge:
kb add/search/stats/ask/eval/forget/dedup– direkt im Terminal Schreiben, Suchen, Statistiken und RAG-Fragenbeantwortung ausführenDatenschutz-Guardrail: Sensible namespaces erzwingen lokale Antworten ohne Datenabfluss ins Internet;
/askintelligentes Routing (lokal zuerst, schwierige Fragen optional in die Cloud)Offline verfügbar: Modelle und Daten liegen vollständig lokal; ohne Netzwerk sind Zugriff und Suche voll funktionsfähig
Schnellstart (Windows / Linux / macOS)
Windows PowerShell:
# 1. 创建并激活虚拟环境
python -m venv venv
.\venv\Scripts\Activate.ps1
# 2. 安装依赖
pip install -r requirements.txt
# 3. 启动服务(默认监听 http://127.0.0.1:8000)
python -m kb serveLinux / macOS:
# 1. 创建并激活虚拟环境
python3 -m venv venv
source venv/bin/activate
# 2. 安装依赖
pip install -r requirements.txt
# 3. 启动服务
python -m kb serveWichtig: Der Befehl
kbwird nur in der virtuellen Umgebung installiert. In jedem neuen Terminal muss zuerst die virtuelle Umgebung aktiviert werden (Windows.\venv\Scripts\Activate.ps1, Linux/macOSsource venv/bin/activate), sonst erscheint die Meldungkb:未找到命令. Mitpython -m kb <子命令>lässt sich die Aktivierung umgehen.Alternative Schnellinstallation (ohne virtuelle Umgebung, Python 3.10+):
pip install --user -r requirements.txtund dann mitpython -m kb serveausführen; es wird jedoch empfohlen, bevorzugt venv zur Isolierung der Abhängigkeiten zu verwenden.
Gesundheitscheck nach dem Start:
curl http://127.0.0.1:8000/api/v1/healthzBeim ersten Start wird das lokale Embedding-Modell geladen (standardmäßig BAAI/bge-m3, ca. 2 GB, muss vorab heruntergeladen und zwischengespeichert werden); wenn kein LLM konfiguriert ist, startet der Dienst wie gewohnt;
/askliefert 503 und Konfigurationshinweise zurück.LLM ist standardmäßig deaktiviert (
KB_LLM_MODE=off): Der Dienststart erkennt/lädt/ruft kein großes Modell auf, null VRAM, null Kosten, rein offline; Erinnerungen schreiben, Dokumentaufnahme und hybride Suche sind vollständig nutzbar. Wenn RAG-Fragenbeantwortung (/ask) benötigt wird, konfigurieren Sie wie unten ein lokales oder Cloud-LLM.
LLM konfigurieren (optional, für die /ask-Fragenbeantwortung erforderlich)
KB_LLM_MODE ist standardmäßig off (wird nicht geladen und nicht aufgerufen); vier Stufen:
Stufe | Verhalten |
| LLM wird überhaupt nicht geladen/aufgerufen; Erinnerungszugriff und Suche vollständig nutzbar |
| Nur lokales Ollama (vollständig offline, Datenschutz ohne Abfluss nach außen) |
| Lokal bevorzugt, Cloud-Fallback: Wenn lokales Ollama verfügbar ist, wird lokal verwendet; wenn kein lokales, aber ein Cloud-Schlüssel vorhanden ist, in die Cloud |
| Alles über die Cloud (lokal nur Komprimierung und Datenschutzisolierung) |
Lokales LLM (Ollama):
# 1. 安装并启动 Ollama(Windows 从开始菜单/托盘启动,不要从 AI 沙箱终端拉起)
# 2. 拉取一个适合你电脑的模型(按显存/内存选择,如 qwen3:4b 约 3.2GB、
# qwen3:1.7b 约 1.8GB;国内可用魔搭加速,拉完 ollama cp 改成短名)
ollama pull <你的模型名>
# 3. 在 .env 配置后重启服务:
# KB_LLM_MODE=local # 仅本地
# KB_LLM_MODEL=<你的模型名> # 以 `ollama list` 输出的名称为准
# KB_OLLAMA_BASE_URL=http://localhost:11434Cloud-LLM (beliebiger OpenAI-kompatibler Anbieter, nicht an DeepSeek gebunden): DeepSeek / OpenAI / 通义千问 / 硅基流动 / Moonshot usw. sind möglich, allgemein drei Schlüssel:
# .env
KB_LLM_MODE=auto # 本地优先、云端降级;或 cloud 全云端
KB_LLM_API_KEY=sk-xxx # 服务商 API Key
KB_LLM_BASE_URL=https://api.deepseek.com # 换成你所用服务商的 OpenAI 兼容端点
KB_LLM_CLOUD_MODEL=deepseek-v4-flash # 云端模型名Überprüfung: Das Feld llm von GET /api/v1/healthz – local/cloud bedeutet, das LLM ist bereit, disabled bedeutet nicht aktiviert.
Häufige Probleme: Download des Embedding-Modells schlägt fehl
Bei direkter Verbindung aus dem chinesischen Festland zu
huggingface.cokommt es zu Zeitüberschreitungen. HF-Mirror setzen und neu starten:export HF_ENDPOINT=https://hf-mirror.com # 或写入 ~/.bashrc 永久生效 python -m kb serveDas Modell wird automatisch vom Mirror heruntergeladen und in
~/.cache/huggingface/hub/zwischengespeichert; danach kann es auch ohne Netzwerk offline geladen werden.Modell ist lokal zwischengespeichert, aber kein externes Netzwerk:
kbverwendet Offline-First (zuerst lokalen Cache treffen, nur bei Fehlschlag online gehen); solange das Cache-Verzeichnis vollständig ist, läuft es vollständig offline.
Agents an kb anbinden (clientunabhängig)
Übergeben Sie die Integrationsspezifikation von kb an den KI-Client (TraeWork / Claude Code / Cursor / selbst erstellte Agents), damit diese wissen, wie sie Erinnerungen lesen und schreiben, nach welcher Identitätskonvention sie vorgehen und wie sie das Audit abfragen. Zwei Wege, wählen Sie einen davon:
Skill (empfohlen, kann automatisch ausgelöst werden) – optionaler, unabhängiger Schritt: Das
skills/kb-memory/SKILL.mdim Repository ist ein clientunabhängiger Skill im offenen Anthropic-Format. Nach der Installation im Benutzer-Skills-Verzeichnis des von Ihnen verwendeten Clients wird der Skill in jeder Projektsitzung dieses Clients beim Lesen/Schreiben von Erinnerungen / RAG-Fragenbeantwortung / Audit-Abfragen automatisch erkannt und ausgelöst. Installation = einfach das Verzeichnisskills/kb-memorydorthin kopieren (es gibt ein Skript, manuelles Kopieren ist ebenfalls möglich, keine Abhängigkeiten erforderlich); Aktualisierung (erneutes Überschreiben), Deinstallation sowie Nutzungshinweise nach der Installation finden Sie inscripts/README.md.Das Nichtinstallieren beeinträchtigt den kb-Dienst nicht: Der Skill ist nur eine „Prompt-Verpackung“ für KI-Clients und hat nichts mit Installation und Start des Dienstes zu tun – überspringen Sie diesen Schritt, der Dienst läuft normal weiter; Sie können jederzeit über die reinen Text-Prompts aus Methode 2 anbinden; die Skill-Installation ist einmalig, bei Bedarf und unabhängig ausführbar; sie wird nicht automatisch mit
kb serveausgelöst und schreibt keine Dateien außerhalb der Verzeichnisse Ihres Clients.Reiner-Text-Prompt (Fallback, universell für jeden Client): Den gesamten Abschnitt aus
docs/AGENT_PROMPT.mdkopieren und dem Agent einfügen; keine Skill-Mechanik nötig.
Sind
.trae-cn/skills/.claude/skills/.cursor/skillsein von allen Clients anerkannter „Standard“? – Nein. Diese sind lediglich die benutzerbezogenen Konventionsverzeichnisse der jeweiligen Clients:SKILL.mdselbst ist ein einheitliches offenes Anthropic-Format, aber „in welches Verzeichnis installiert wird und ob automatisch ausgelöst wird“, entscheidet jeder Client selbst; der Unterstützungsgrad ist unterschiedlich:
Client | Benutzerbezogenes Skills-Verzeichnis | Automatisches Laden |
TraeWork |
| Automatische Erkennung |
Claude Code |
| Von höheren Versionen unterstützt |
Cursor |
| Wird schrittweise übernommen |
Andere / selbst erstellte Agents | Keine einheitliche Konvention | Muss manuell geladen werden oder nicht unterstützt |
Es gibt kein einheitliches Verzeichnis, dem „alle Clients folgen“; wenn Ihr Client Skills nicht unterstützt, gibt es immer Methode 2 als Fallback (
AGENT_PROMPT.mdeinfügen, reiner Text für jeden Client nutzbar). Installationsmethode, Verzeichnisunterschiede und Lademechanismen der Clients sowie gegenseitige Referenzbeziehungen: Details finden Sie inscripts/README.md(hier nicht wiederholt).
MCP-Einbindung
MCP-Endpunkt (streamable HTTP): http://127.0.0.1:8000/mcp/
Claude Code: Dieses Repository enthält bereits ein projektweites .mcp.json; beim Start von Claude Code in diesem Verzeichnis wird es automatisch eingebunden;
es kann auch global hinzugefügt werden:
claude mcp add --transport http kb http://127.0.0.1:8000/mcp/Cursor / TraeWork und andere MCP-fähige Clients: Fügen Sie in der MCP-Konfiguration folgendes JSON hinzu
(Cursor in ~/.cursor/mcp.json oder Projekt-.cursor/mcp.json; TraeWork unter Einstellungen MCP-Server hinzufügen):
{
"mcpServers": {
"kb": {
"type": "http",
"url": "http://127.0.0.1:8000/mcp/"
}
}
}Nach der Einbindung verfügbare MCP-Tools: write_memory / search_memory / read_memory /
update_memory / delete_memory / add_document / add_webpage / ask_kb.
Nach Aktivierung der
KB_API_KEY-Authentifizierung müssen MCP-Clients in der Verbindungskonfigurationheadershinzufügen (Authorization: Bearer <key>); die.mcp.json-Vorlage im Repository enthält keinen echten Schlüssel (JSON unterstützt keine Kommentare); die Konfiguration finden Sie in USER_GUIDE §5.2.
REST-Endpunkte im Überblick
Methode | Pfad | Beschreibung |
POST |
| Erinnerung schreiben |
GET |
| Erinnerungsliste, unterstützt Filterung nach |
GET |
| Einzelne Erinnerung lesen |
PATCH |
| Inhalt oder Tags aktualisieren |
DELETE |
| Einzelne Erinnerung löschen |
POST |
| Hybride Suche |
POST |
| Dokumentaufnahme: multipart-Feld |
GET |
| Liste der aufgenommenen Dokumente (nach source aggregiert) |
DELETE |
| Alle Datensätze dieses Dokuments nach source löschen |
POST |
| Webseitenaufnahme |
POST |
| RAG-Fragenbeantwortung |
GET |
| Gesundheitscheck und Dienststatistiken |
GET |
| Statistiken zur Erinnerungs-Governance: |
GET |
| Governance-Konfiguration: Schalter und Parameter für Abklingen + Frische (nur lesen) |
POST |
| Nach Aktivieren der semantischen Deduplizierung ( |
Erinnerungs-Governance (Deduplizierung/Abklingen/Frische) ist standardmäßig deaktiviert, null Verhaltensänderungen; Verwendung siehe USER_GUIDE §3.5.
Beispiel:
# 写入一条记忆
curl -X POST http://127.0.0.1:8000/api/v1/memories `
-H "Content-Type: application/json" `
-d '{"content": "用户偏好深色主题", "tags": ["偏好"]}'
# 混合检索
curl -X POST http://127.0.0.1:8000/api/v1/search `
-H "Content-Type: application/json" `
-d '{"query": "用户界面偏好", "top_k": 5}'
# RAG 问答(需配置 LLM)
curl -X POST http://127.0.0.1:8000/api/v1/ask `
-H "Content-Type: application/json" `
-d '{"question": "用户喜欢什么主题?"}'Konfigurationsparameter im Überblick
Alle Konfigurationen werden über Umgebungsvariablen mit KB_-Präfix oder über die Datei .env bereitgestellt; die vollständigen Schlüsselnamen finden Sie in .env.example
(nach dem Kopieren in .env ausfüllen; .env ist durch gitignore abgedeckt, echte Schlüssel nur auf dem lokalen Rechner aufbewahren, auf keinen Fall einchecken).
Konfiguration | Standardwert | Beschreibung |
|
| LLM-Modus: |
| leer | Gerät für das Embedding-Modell: leer=automatische Erkennung, explizit |
|
| Im serve-Modus überwachtes Verzeichnis; Dateiänderungen werden automatisch aufgenommen; leere Zeichenkette oder |
|
| Wurzelverzeichnis der Laufzeitdaten (ChromaDB, Laufzeitstatus usw.) |
|
| Listening-Adresse für REST und MCP |
|
| Embedding-Modell |
| leer | Lokaler Ollama-Modellname (Standard leer=nicht konfiguriert; bei |
|
| Ollama-Endpunkt |
| leer | Cloud-LLM (optional): beliebiger OpenAI-kompatible Anbieter (DeepSeek / OpenAI / 通义 / 硅基流动 usw.), nur in die lokale |
|
| Parameter für Dokeumentsegmentierung |
| leer | Kommagetrennte sensible namespaces; bei Treffer wird lokale Antwort erzwungen, ohne Datenabfluss ins Internet |
| leer | leer=keine Authentifizierung (lokale Schleife ohne Reibung); nicht leer=Bearer/X-API-Key-Authentifizierung aktiviert; orchestra-Clients senden automatisch den Header |
|
| Feinranking der Suche (A3.5): fusierte Kandidaten werden per CrossEncoder neu bewertet, standardmäßig aus |
|
| Dritter Sparse-Pfad (A3.5): BGE-M3-Sparse-Vektoren + invertierter Index nehmen an der RRF-Fusion teil, standardmäßig aus |
CLI-Schnellübersicht (ohne Dienststart)
python -m kb add "记忆内容" --tags 偏好 --client TraeWork # 写入(project 缺省自动取当前目录名)
python -m kb search "查询词" --client TraeWork # 混合检索(只回本客户端+本项目的 memory)
python -m kb stats # 统计:类型分布 / 访问热度 / 陈旧分布
python -m kb ask "问题" --client TraeWork # 终端 RAG 问答(LLM 不可用时输出检索命中)
python -m kb audit --client TraeWork --days 7 # 查某客户端/项目存过/读过什么
python -m kb eval --file tests/eval_zh_50.jsonl # 检索质量评测(Recall@1/@5 + MRR)
python -m kb forget --stale --days 90 # 清理超期未命中记忆
python -m kb dedup --threshold 0.92 # 语义去重
kb askverbindet sich direkt mit der lokalen Dienstlogik (nicht über HTTP); empfohlen, wennservegestoppt ist, um Schreibkonkurrenz zweier Prozesse auf die Datenbank zu vermeiden.
agent-orchestra — Multi-Agent-Kollaborationssystem (experimentell)
Mehrere KI-Assistenten (verschiedene TraeWork-Aufgaben / Claude-Code-Sitzungen, Modelle können unterschiedlich sein) entwickeln über das gemeinsame kb-Taskboard kollaborativ: Die Koordinator-KI zerlegt Karten und verteilt sie, die Worker-KI übernimmt Karten und führt sie aus (eine Karte pro Runde) und schreibt Ergebnisse zurück; der Koordinator prüft und lässt den Workflow weiterlaufen.
# 前置:kb serve 已运行。开一个新 TraeWork 任务,粘贴以下引导语即可唤醒一个 worker:
venv\Scripts\python.exe orchestra\board.py new-worker worker-1Die vollständige Verwendung (wie der Koordinator Karten zerlegt, wie mehrere Worker parallel arbeiten, Kollaborationsdisziplin und bekannte Einschränkungen) finden Sie in Benutzerhandbuch, Abschnitt 4.
Verzeichnisstruktur
kb/ kb 服务源码(config / models / embedder / storage / bm25 / retriever /
service / llm / ingest / watcher / api / mcp / cli + reranker / sparse / eval)
tests/ kb 验收测试(339 项,含 eval_zh_50.jsonl 检索评测数据集)
orchestra/ 多 Agent 协作系统(board.py CLI + 协议三件套 + skill + 245 项测试)
docs/ 设计文档、节点计划、用户使用手册
kb_data/ kb 运行数据(gitignore)
_archive/ 旧学习项目归档(仅保留历史,禁止参考)Weitere Dokumentation
Benutzerhandbuch (Einstieg für menschliche Benutzer): docs/USER_GUIDE.md
KI-Übergabedokument (Einstieg für KI-Assistenten): PROJECT.md (Projektstatus / Fortschritts-Board / Übergabeanleitung)
Designdokument (Anforderungen, Architektur, API, Meilensteine):
docs/superpowers/specs/2026-08-23-kb-memory-service-design.mdP2-Logging-Design:
docs/superpowers/specs/2026-08-24-logging-design.mdP2-Roadmap:
docs/superpowers/plans/2026-08-24-p2-roadmap.mdKnoten-Entwicklungsplan:
docs/superpowers/plans/2026-08-23-kb-dev-nodes.mdKI-Kollaborationsrichtlinien:
AGENTS.md
Available Tools
13 toolsadd_documentB
导入本地文档(PDF/DOCX/MD/TXT 及 Office 格式)切分入库; 返回 {"source": 文件名, "chunks": 块数};文件不存在或格式不支持时 返回 {"error": "FILE_NOT_FOUND" | "UNSUPPORTED_FORMAT", "message": 原因}。 project:文档 chunk 落入该项目子库(空=全局库);client:仅用于审计归类。 English: Import a local document (PDF/DOCX/MD/TXT and Office formats), split and ingest it; returns {"source": filename, "chunks": count}; when the file is missing or the format is unsupported returns {"error": "FILE_NOT_FOUND" | "UNSUPPORTED_FORMAT", "message": reason}. project: chunks go to that project's sub-store (empty = global); client is audit-only.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| client | No | ||
| project | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations exist, so the description carries the full burden; it usefully discloses the return shape (source/chunks) and the two error codes with reasons, which is real behavioral value. However it omits permissions/auth, idempotency, and what happens on re-import or duplicate files.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loads the operation and return contract, which is good structure. But the entire content is duplicated in Chinese and English, roughly doubling length without adding information, and the parameter notes trail after the return-value block.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema the description correctly supplies the return and error contract, and with no annotations it covers parameter meaning. It is only missing the safety/permission profile and path-format semantics, so it is close to complete for a 3-parameter ingest tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It does well for project (sub-store target, empty = global) and client (audit-only), but the required `path` parameter is left unqualified – no indication of whether it is a server-side or client-side path or an absolute vs relative path.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb (import/split/ingest) and resource (local document) plus the supported formats, so it is distinguishable from the sibling add_webpage via the 'local' qualifier. It stops short of naming the sibling explicitly, but the intent is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No explicit when-to-use or when-not-to-use guidance. It never mentions add_webpage (the obvious alternative for remote content) or any prerequisite/precondition, leaving the agent to infer that this tool is only for local files.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
add_webpageA
抓取网页正文并切分入库;返回 {"source": url, "chunks": 块数}; 抓取/正文提取失败时返回 {"error": "WEB_FETCH_FAILED", "message": 原因}。 project:web chunk 落入该项目子库(空=全局库);client:仅用于审计归类。 English: Fetch a webpage body and ingest it after splitting; returns {"source": url, "chunks": count}; on fetch/body-extraction failure returns {"error": "WEB_FETCH_FAILED", "message": reason}. project: chunks go to that project's sub-store (empty = global); client is audit-only.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| client | No | ||
| project | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does reasonably well: it discloses both the success return shape ({source, chunks}) and the failure shape including the WEB_FETCH_FAILED error code and a reason message. It also explains the storage scoping rule (project sub-store vs global). It stops short of auth requirements, rate limits, or duplicate-URL behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The content is front-loaded and each piece of information is useful, but the entire description is duplicated verbatim in Chinese and English, which doubles the token cost without adding information for a reader who understands either language.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
There is no output schema, so the description's disclosure of the return and error shapes is exactly what is needed. For a simple 3-parameter ingestion tool with no annotations, the description covers purpose, parameters, and outcomes adequately; only operational details like deduplication or size limits are absent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, and it does for the non-obvious parameters: 'project' is explained as the destination sub-store with empty meaning global, and 'client' is explicitly flagged as audit-only metadata. 'url' is self-evident. This adds real meaning beyond the echoed titles in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a concrete verb chain and resource: fetch a webpage body, split it, and ingest it into the store. That is far more specific than the bare name, but it never differentiates itself from the sibling add_document (file-based ingestion) or write_memory, so an agent must infer which ingestion tool to pick.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied by the phrase 'fetch a webpage body and ingest it' — an agent can infer this is for pulling web content into the knowledge base. There is no statement of when to prefer add_document over this tool, no prerequisites, and no exclusions (e.g. unsupported schemes or already-ingested URLs).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
ask_kbA
基于知识库的 RAG 问答(检索 → 上下文拼装 → 护栏生成),返回 answer 与 sources; project:检索该项目子库 + 全局库(空=仅全局库),并写 ask 存取审计; client:来源客户端(可选,缺省从 clientInfo 自动识别,仅审计); LLM 不可用时返回 {"error": "LLM_DISABLED", "message": 配置指引}。 English: Knowledge-base RAG Q&A (retrieve → build context → guarded generation), returning answer and sources; project: search that project's sub-store plus the global store (empty = global only); an ask access-audit is emitted; client is audit-only; returns {"error": "LLM_DISABLED", "message": setup guidance} when the LLM is unavailable.
| Name | Required | Description | Default |
|---|---|---|---|
| client | No | ||
| project | No | ||
| question | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations the description carries the full burden, and it does disclose meaningful behavior: the retrieve→context→guarded-generation pipeline, the side effect that an ask access-audit is written, that client is audit-only, and the exact failure contract {"error": "LLM_DISABLED", ...}. It stops short of covering auth requirements, rate limits, or result-size limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The content is front-loaded and dense, but the English block restates the Chinese block nearly verbatim, roughly doubling the length without adding information. A single-language description would carry the same payload.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema exists, so the description correctly takes on the return contract (answer + sources, plus the error object) and covers the one non-obvious side effect. Missing detail is limited to the shape of sources and any size or rate limits.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It successfully explains project (sub-store + global, empty = global only) and client (optional, auto-detected from clientInfo, audit-only), which the schema alone gives no meaning for. Only 'question' is left without added detail, but its meaning is self-evident.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: 'Knowledge-base RAG Q&A (retrieve → build context → guarded generation), returning answer and sources'. It is unambiguous about what the tool produces, but it does not name or contrast with siblings such as search_memory, so an agent must infer the boundary itself.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied by the pipeline and by the project/client explanations, and the LLM-disabled fallback gives situational context. However, there is no explicit when-to-use-this-vs-search_memory guidance, no statement about question phrasing, and no exclusion conditions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_documentA
按 source 删除一份 RAG 文档/网页/表格的全部记录,返回 {"source", "deleted"}; 删除会级联清理 BM25 与向量索引;source 为空时返回 INVALID_ARGUMENT。 project 指定项目子库(空=全局库);client 仅用于审计归类。 English: Delete all records of one RAG document/webpage/table by source, returning {"source", "deleted"}; cascades to BM25 and vector indexes; empty source returns INVALID_ARGUMENT. project selects the sub-store (empty = global); client is audit-only.
| Name | Required | Description | Default |
|---|---|---|---|
| client | No | ||
| source | Yes | ||
| project | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden and does substantial work: it discloses cascade deletion of BM25 and vector indexes, the {"source", "deleted"} return shape, the INVALID_ARGUMENT failure for empty source, and that client is audit-only metadata. It stops short of stating whether deletion is recoverable, what the `deleted` count represents, or whether elevated permissions are required for a destructive operation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Content is front-loaded with the destructive scope and cascade behavior in the opening sentence, which is correct ordering. But the entire text is duplicated verbatim in Chinese and English, roughly doubling length with zero added information for a single agent, and the parenthetical error/parameter notes are run together in one block.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 3-parameter destructive tool with no annotations and no output schema, the description supplies the essential load-bearing facts: what gets removed, that secondary indexes are cascaded, the return shape, and the error condition. Only permission/auth prerequisites and irreversibility are unstated, which is a minor residual gap given the rest of the coverage.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, and it explains the role of all three parameters: project selects the sub-store (empty = global), client is audit-only, and source is the deletion key. The remaining gap is that the required `source` parameter's expected format (exact URL, path, or filename) and matching semantics are never specified.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource with explicit scope: delete *all records* of one RAG document/webpage/table, keyed by source. That scope wording distinguishes it from the sibling delete_memory (which operates on memories, not ingested document records) without needing to open either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies when to use it (purge a whole document's records by source) and explains the project sub-store selection and the empty-source error case. However it gives no explicit when-not-to-use guidance, never mentions the delete_memory sibling, and does not say anything about confirming intent before a destructive purge.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
delete_memoryA
按 ID 删除一条记忆;成功返回 {"ok": true},记录不存在返回 {"error": "NOT_FOUND"}。 project:先查该项目子库,再查全局库;不传时先查全局库再查各项目子库。 client:来源客户端(可选,缺省从 clientInfo 自动识别,仅审计)。 English: Delete a memory by ID; returns {"ok": true} on success and {"error": "NOT_FOUND"} when it does not exist. project: locate in that project's sub-store then the global store; when omitted, global first and then each project store. client is audit-only.
| Name | Required | Description | Default |
|---|---|---|---|
| client | No | ||
| project | No | ||
| record_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does well: it discloses return payloads ({'ok': true} vs {'error': 'NOT_FOUND'}), the scoped search order for project, and that client is audit-only with auto-detection from clientInfo. It omits whether deletion is permanent/irreversible and any permission requirements.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Content is front-loaded and clear, but it is presented bilingually with the English text duplicating the Chinese nearly verbatim, roughly doubling the length without adding information. That redundancy costs efficiency.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutating tool with no annotations and no output schema, the description covers the essentials: return values, project scoping order, and audit behavior. It is nearly complete, only missing auth/irreversibility details and guidance on obtaining record_id.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate. It explains 'project' lookup behavior and clarifies 'client' is optional and audit-only, but says nothing about the required 'record_id' (format, where to obtain it), leaving one of three params undocumented.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('Delete a memory by ID') and the operation is unambiguously distinct from siblings like read_memory, update_memory, and write_memory. An agent can identify the correct tool without inspecting the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explains the resolution behavior for the 'project' parameter (project sub-store vs global store, and the lookup order when omitted), which is the main usage-relevant context. It does not state explicit when-not-to-use conditions or name alternative tools, but the delete semantics are self-evident.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
link_memoryA
建立两条记忆的关联(related/supersedes/depends_on/part_of/contradicts); 重复建边幂等(created=false)。仅同作用域的 memory 记录可关联,禁止自关联; 失败返回 {"error": , "message": 原因}(NOT_FOUND/SELF_LINK/...)。 project:项目子库(空=全局库);client:仅审计。 English: Link two memories (related/supersedes/depends_on/part_of/contradicts); duplicate edges are idempotent (created=false). Only memory records in the same scope can be linked, and self-links are rejected; failures return {"error": , "message": reason}.
| Name | Required | Description | Default |
|---|---|---|---|
| to_id | Yes | ||
| client | No | ||
| from_id | Yes | ||
| project | No | ||
| relation | No | related |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does well: it discloses idempotency semantics (`created=false`), the scope-consistency restriction, self-link rejection, and the failure envelope `{"error": <CODE>, "message": reason}` with sample codes. It omits permission/auth requirements and the full success payload beyond the `created` flag.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Each half is tight and front-loaded with the core action before the constraints, but the entire body is duplicated verbatim in Chinese and English, roughly doubling length without adding information. Efficient content, wasteful packaging.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no annotations and no output schema, the description covers the mutation's semantics, constraints, idempotency and error shape — enough to invoke correctly. Only the precise success return value and any authorization preconditions are unstated.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate — and it does for the non-obvious parameters: the five valid `relation` values, `project` (empty = global library) and `client` (audit only). `from_id`/`to_id` are left undefined but are self-evident from the purpose statement.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource ("Link two memories") and enumerates the exact relation vocabulary (related/supersedes/depends_on/part_of/contradicts), which also implicitly distinguishes it from the sibling `unlink_memory`. An agent knows precisely what this tool creates without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives concrete preconditions: both records must be in the same scope, self-links are rejected, and duplicate edges are idempotent. It does not explicitly route the agent to `unlink_memory`/`list_links` for the inverse or inspection cases, which keeps it short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_documentsA
列出已入库的 RAG 内容(按 source 聚合,kind=doc/web/table), project 指定项目子库(空=全局库);client 仅用于审计归类。 返回 [{"source", "chunks", "chars", "last_imported", "kind"}]。 English: List ingested RAG content grouped by source (kind=doc/web/table); project selects the sub-store (empty = global); client is audit-only. Returns [{"source", "chunks", "chars", "last_imported", "kind"}].
| Name | Required | Description | Default |
|---|---|---|---|
| client | No | ||
| project | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are supplied, so the description carries the full burden, and it does disclose genuinely non-obvious behavior: results are pre-aggregated per source with chunk and character counts, 'client' does not filter but is audit-only, and an empty project means the global store. What is missing is any statement about ordering, result limits, or behavior on an empty store — relevant for a listing call that can return many sources.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Each language block is well front-loaded (purpose first, then parameters, then return shape), but the entire content is duplicated in Chinese and English, effectively doubling length with no added information. It also restates the return fields even though an output schema already exists.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 0-required-parameter read-only listing tool with only two optional parameters and an output schema, the description covers purpose, both parameters, and aggregation semantics. The residual gap is operational detail (ordering, limits) that an agent might want when the store is large.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, and it does: it explains that project selects the sub-store with empty meaning global, and that client is audit-only rather than a filter — meaning an agent could not derive from the schema alone. It stops short of stating accepted value formats or whether unknown project names error or return empty.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('List ingested RAG content') plus the aggregation semantics ('grouped by source') and the kind values allowed (doc/web/table). It is clearly an inventory/listing tool, distinguishable in intent from siblings like ask_kb or search_memory, though it never names an alternative explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is only implied: the reader can infer this is the browse/inventory step rather than the retrieval step, and the note that project empty = global is a scoping rule. There is no explicit when-to-use/when-not guidance and no mention of ask_kb or search_memory as the alternative for content lookup.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_linksB
列某条记忆的一跳邻居,返回 {"record_id", "links"};每项含 id/content/type/tags/relation/direction(out/in/both)。 记录不存在返回 {"error": "NOT_FOUND"}。 English: List one-hop neighbors of a memory as {"record_id", "links"}; each item has id/content/type/tags/relation/direction (out/in/both).
| Name | Required | Description | Default |
|---|---|---|---|
| client | No | ||
| project | No | ||
| relation | No | ||
| record_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must describe behavior itself. It does describe the response keys and the error payload ('记录不存在返回 {"error": "NOT_FOUND"}'), which is useful. However, it says nothing about permissions, result-set size limits, pagination, or the cost of traversing a high-degree node.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose is front-loaded in the first clause, and the error behavior follows compactly. The content is fully duplicated in Chinese and English, which doubles the length without adding information, but each half is efficient and the overall size is manageable.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description compensates well for the missing output schema by specifying the response keys and the NOT_FOUND payload. With no annotations and 0% parameter coverage, however, an agent still cannot tell what 'client', 'project', or 'relation' do, so the definition is not complete enough for confident invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% across 4 parameters, so the description must explain them, but it does not. 'relation' and 'direction' appear only as returned fields, not as input filters, and 'client'/'project' are never mentioned at all, leaving half the schema opaque.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a precise verb and resource: 'List one-hop neighbors of a memory'. It also states the return shape, {'record_id','links'}. It never names a sibling such as search_memory or read_memory, so the agent must infer that this is a graph-traversal tool rather than a keyword search, but the purpose itself is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The phrase 'one-hop neighbors' implies graph exploration, but the description gives no explicit condition for choosing this tool over read_memory or search_memory, and it does not say when not to use it. The only usage behavior it states is the NOT_FOUND case for a nonexistent record.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
read_memoryA
按 ID 读取单条记忆完整内容;记录不存在返回 {"error": "NOT_FOUND"}。 project:先查该项目子库,再查全局库;不传时先查全局库再查各项目子库。 client:来源客户端(可选,缺省从 clientInfo 自动识别,仅审计)。 English: Read the full content of a single memory by ID; returns {"error": "NOT_FOUND"} when absent. project: search that project's sub-store first, then the global store; when omitted, global first and then each project store. client is audit-only.
| Name | Required | Description | Default |
|---|---|---|---|
| client | No | ||
| project | No | ||
| record_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does disclose meaningful behavior: the exact NOT_FOUND error shape, the store-resolution order for project lookups (project sub-store then global, vs global then each project store when omitted), and that client is audit-only and auto-detected. It stops short of stating permissions or the success payload shape.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core action is front-loaded and each sentence carries information, but the full Chinese/English duplication roughly doubles the length for a single-language agent, which is redundant rather than additive.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
No output schema exists, and the description covers the failure return and store-resolution behavior, which are the non-obvious parts. The success payload is only gestured at ('full content'), a minor gap for a read-by-ID tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, and it explains two of three parameters well: project's lookup-order semantics and client being optional, auto-detected, and audit-only. record_id is left undefined but is self-evident from 'by ID'.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Read the full content of a single memory by ID'), and the singular 'by ID' framing cleanly separates it from the sibling search_memory, which returns multiple matches. An agent can pick correctly without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The 'by ID' phrasing implies it is a direct-lookup tool that presupposes a known identifier, but the description never states when to prefer it over search_memory or how to obtain a record_id. Usage is inferred from context rather than stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_memoryA
混合检索记忆与知识(向量语义 + BM25 关键词,归一化融合); 返回命中列表,每项含 id/content/score/type/source。 project 指定项目子库时,检索范围 = 该项目子库 + 全局库(项目命中加分); 不传 project 时只检索全局库。 top_k 小于 1 时返回 {"error": "INVALID_ARGUMENT", "message": 原因}。 client:来源客户端(可选,缺省从 clientInfo 自动识别,仅审计)。 English: Hybrid retrieval over memories and knowledge (vector semantics + BM25 keywords, normalized fusion); returns a hit list, each item having id/content/score/type/source. With project, the scope is that project's sub-store plus the global store (project hits boosted); without project, only the global store is searched. Returns {"error": "INVALID_ARGUMENT", "message": reason} when top_k is less than 1. client: source client (optional; auto-detected from clientInfo when omitted; audit only).
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| top_k | No | ||
| client | No | ||
| project | No |
Output Schema
| Name | Required | Description |
|---|---|---|
| result | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden and largely meets it: it discloses the return shape (id/content/score/type/source per hit), the error contract for top_k < 1, the project-boost behavior, and that client is audit-only. It omits auth/permission requirements and any latency or rate-limit context, keeping it out of 5 territory.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Content is front-loaded and each clause carries information, but the entire description is duplicated verbatim in Chinese and English, roughly doubling the length for the same payload. That redundancy is a real cost against a tight token budget even if it aids bilingual readability.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a four-parameter retrieval tool with an output schema present, the description covers the scoping model, error behavior, and audit-only client well enough to call correctly. Since an output schema exists it need not detail return values, though it helpfully does; only query semantics and default top_k are left unaddressed.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, and it does for most parameters: project's scoping effect, top_k's validation boundary, and client's optional/auto-detected/audit-only nature. The query parameter itself is left unexplained and top_k's default (5) and result-count meaning are not spelled out, so it is strong but not complete.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource — hybrid retrieval over memories and knowledge — and even names the retrieval mechanism (vector semantics + BM25, normalized fusion), so the agent knows exactly what operation this performs. It does not, however, differentiate itself from siblings like read_memory or ask_kb, so it falls short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied through conditional scoping rules (with project → project sub-store + global; without project → global only), which tells the agent how the call behaves. But there is no explicit guidance on when to choose this over ask_kb or read_memory, and no exclusions stated.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
unlink_memoryB
取消两条记忆的关联(任一方向);relation 为空时删除该对全部关系。 返回 {"ok": true, "removed": 删除数};记录不存在返回 {"error": "NOT_FOUND"}。 English: Remove links between two memories in either direction; when relation is empty all relations of the pair are removed. Returns {"ok": true, "removed": n}.
| Name | Required | Description | Default |
|---|---|---|---|
| to_id | Yes | ||
| client | No | ||
| from_id | Yes | ||
| project | No | ||
| relation | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden and does disclose return values and an error case ({"ok": true, "removed": n} and NOT_FOUND). However, it does not state whether unlinking is reversible, what permissions are required, or any destructive side effects beyond link removal.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core behavior is front-loaded, but the description is duplicated in Chinese and English, creating redundancy rather than added clarity. It remains reasonably short and does not bury the key relation-empty rule.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with no annotations, no output schema, and five parameters at 0% schema coverage, the description leaves important gaps: parameter meanings for client/project/from_id/to_id, required permissions, and reversibility are absent. Return shape and NOT_FOUND are covered, but the overall definition is not complete enough for confident invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must explain all five parameters, but it only clarifies relation semantics and does not explain from_id, to_id, client, or project. An agent must infer the meanings of most parameters from their names alone.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: remove links between two memories, with scope details such as either-direction removal and clearing all relations when relation is empty. This clearly distinguishes it from the sibling link_memory tool.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides implied usage guidance by explaining that an empty relation removes all relations for the pair, but it does not explicitly compare when to use this tool versus link_memory or list_links, nor does it state prerequisites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
update_memoryA
按 ID 更新记忆内容(变更后自动重新嵌入);记录不存在返回 {"error": "NOT_FOUND"}; 内容为空串或纯空白时返回 {"error": "INVALID_ARGUMENT", "message": 原因}。 project:先查该项目子库,再查全局库;不传时先查全局库再查各项目子库。 client:来源客户端(可选,缺省从 clientInfo 自动识别,仅审计)。 English: Update a memory's content by ID (auto re-embed on change); returns {"error": "NOT_FOUND"} when absent; empty content returns {"error": "INVALID_ARGUMENT", "message": reason}. project: locate in that project's sub-store, then the global store; when omitted, global first and then each project store. client is audit-only.
| Name | Required | Description | Default |
|---|---|---|---|
| client | No | ||
| content | Yes | ||
| project | No | ||
| record_id | Yes |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does well: it discloses auto re-embedding, that an absent record returns NOT_FOUND (i.e. no upsert), that blank content yields INVALID_ARGUMENT with a reason, and the project/global store lookup order. It omits permission/auth requirements and whether other fields are preserved, keeping it below 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded, but the content is fully duplicated in Chinese and English, roughly doubling the length for the same information. Each individual sentence earns its place, yet the bilingual redundancy is a real efficiency cost.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 4-parameter mutation tool with no annotations and no output schema, the description supplies the safety-relevant behavior (error codes, no-upsert, re-embed) and the resolution semantics. Auth/authorization and field-preservation behavior are the remaining gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 0%, so the description must compensate, and it covers all four parameters: content (empty/whitespace validation), record_id (lookup by ID), project (sub-store then global lookup order), and client (audit-only, auto-detected from clientInfo). Values are meaningful beyond the bare schema titles.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Update a memory's content by ID') plus the key side effect ('auto re-embed on change'), which clearly separates it from read_memory, delete_memory, and search_memory. It never names a sibling explicitly, so it stops short of a 5, but an agent can pick it correctly without opening the schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Usage is implied rather than stated: the ID-based update signals 'edit an existing record', and the project/client resolution rules tell the agent how to target the record. There is no explicit when-to-use vs write_memory alternative and no prerequisite guidance, so it remains minimum viable.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
write_memoryA
写入一条记忆短文本(事实/笔记/摘要),可选标签;返回 {"id": 记录ID}。 内容为空串或纯空白时返回 {"error": "INVALID_ARGUMENT", "message": 原因}。 project 指定项目子库(空=全局库);client 仅用于审计归类(自动识别); 记录主键由服务端生成。 English: Write a memory short text (fact/note/summary) with optional tags; returns {"id": record_id}. Returns {"error": "INVALID_ARGUMENT", "message": reason} when content is empty or blank. project selects the project sub-store (empty = global); client is audit-bucketing only (auto-detected). The record primary key is generated server-side.
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | ||
| client | No | ||
| content | Yes | ||
| project | No |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does so well: it states the return shape ({"id": record_id}), the validation failure mode and error payload for empty/blank content, that the primary key is server-generated, and that 'client' is audit-only and auto-detected. It omits concurrency/duplicate-handling behavior, which keeps it from a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Core action and return value are front-loaded, and each sentence is informative. The full bilingual duplication roughly doubles the length, but the structure remains clean and non-repetitive per language.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 4-param write tool with no annotations and no output schema, the description covers return value, error case, and all parameter roles, which is enough for correct invocation. Remaining gaps (duplicate handling, size limits on content) are minor.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, so the description must compensate, and it does: content is defined as the fact/note/summary text, project selects the sub-store with 'empty = global', client is audit-bucketing only, and tags is optional. Tags get only a bare mention, leaving room for richer semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb+resource ('write a memory short text (fact/note/summary)') and scopes the content type, so an agent understands what the tool does. It does not explicitly differentiate itself from siblings like update_memory or add_document, so it stops short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It hints at content type (fact/note/summary) but provides no explicit when-to-use guidance, no conditions for choosing this over update_memory, add_document, or add_webpage, and no exclusions. Usage must be inferred entirely from the tool name and contents.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
2 tool updates
v2.4.4- Added
delete_document - Added
list_documents
3 tool updates
v2.2.0- Added
link_memory - Added
list_links - Added
unlink_memory
8 tool updates
- First observed
add_document - First observed
add_webpage - First observed
ask_kb - First observed
delete_memory - First observed
read_memory - First observed
search_memory - First observed
update_memory - First observed
write_memory
TDQS
Scored across 13 tools
Each tool has a clearly distinct resource/action: document ingestion/listing/deletion, memory CRUD, link create/delete/list, hybrid search, and RAG Q&A. The closest pair, search_memory vs ask_kb, is clearly separated by raw retrieval hits versus generated answer with sources.
All 13 tools use snake_case with an imperative verb first, and singular/plural usage is predictable (list_documents, add_document, delete_document; write/read/update/delete_memory). list_links is a minor generic noun but still fits the same verb_noun pattern.
13 tools are well-scoped for a knowledge-base plus memory server: document operations, memory CRUD/search, link operations, and one QA tool. Each tool has a clear role and none feels redundant.
Core lifecycle coverage is strong: document add/list/delete, memory create/read/update/delete/search, link create/delete/list, and RAG Q&A. Minor gaps remain: no update/replace document operation, no explicit table ingestion tool despite kind=table, and no general list-memories endpoint outside search.
Maintenance
Related MCP Connectors
Cloud or self-hosted knowledge for AI agents: hybrid search, reranking, GraphRAG, scoped MCP tools.
Persistent memory for AI agents. Semantic search, memory graph, W3C DID identity.
Persistent memory and knowledge graphs for AI agents. Hybrid search, context checkpoints, and more.
Persistent memory, knowledge graph, task management and more for AI agents via MCP.
Related MCP Servers
- AlicenseAqualityAmaintenancePersistent memory MCP server for AI coding agents (Claude Code, Codex, Gemini CLI). Hybrid retrieval (vector + BM25), cross-encoder reranking, knowledge graph, session checkpoint/resume, and multi-scope isolation. Local-first with LanceDB.3045 npm15MIT
- AlicenseAqualityAmaintenanceDurable hybrid memory for AI agents. Combines vector search, BM25, temporal retrieval, and optional Memgraph knowledge graph via reciprocal rank fusion. 6 MCP tools: health, search, answer, feedback, graph_query, graph_add_triple. Self-hosted with Qdrant backend.7278 PyPI9Apache 2.0
- FlicenseNot gradedqualityDmaintenancePersistent semantic memory MCP server for AI agents with hybrid search, LLM scoring, and decay engine, fully local.2-
- AlicenseNot gradedqualityDmaintenanceMCP server that enables persistent, hybrid, local memory for LLM agents, with vector + BM25 search, knowledge graph, and policy-driven retention, providing token-budgeted context injection for AI assistants.MIT