Skip to main content
Glama

scholar-rag-mcp

Status: Vorabversion (v0.1.0). Schnittstellen und Speicherlayout können sich in zukünftigen Versionen ändern.

scholar-rag-mcp ist ein veröffentlichbares MCP-Tool für eine Wissensdatenbank akademischer Paper. Weisen Sie es auf einen Ordner mit PDFs hin, und es verarbeitet jedes Paper durch eine echte Parsing-Pipeline (MinerU), normalisiert Metadaten, annotiert die Abschnittsstruktur, chunked und embeddet den Text und speichert alles in Qdrant – danach kann ein Agent (oder Sie) semantisch nach Chunks suchen, PubMed-artige Dokumentabfragen ausführen, Volltexte Abschnitt für Abschnitt lesen, einzelne Paper hinzufügen/entfernen und Wissensdatenbanken verwalten – alles über 11 MCP-Tools über stdio. Embedding, Annotation und Re-Ranking laufen über OpenAI-kompatible Modelldienste (vLLM) mit In-Process-Fallbacks.

Funktionen

  • Echte Verarbeitungspipeline: MinerU-PDF-Parsing (python/cli/api-Backends) -> Metadatenextraktion (lokale Heuristiken, CrossRef, optional GROBID) -> Bereinigung -> Abschnittsannotation -> deterministisches Chunking (konfigurierbar 300/1500/100 Zeichen) -> Embedding.

  • Schnelle Abfrage bei Skalierung: Embedding-First-Pass + Cross-Encoder-Re-Rank, optionale Metadatenfilter (doc_id, section, year, journal, ...), die innerhalb des Qdrant-Index ausgewertet werden. 100k-Chunk-p95-Abfragelatenz < 1s (siehe docs/perf-report.md).

  • Asynchrone Jobs: create_kb/add_document sind Hintergrundjobs, deren Fortschritt über get_job abgefragt werden kann; sicher neu startbar (unterbrochene Jobs werden wiederhergestellt und beim erneuten Ausführen übersprungen).

  • Kontextsicheres Lesen: paginiertes get_document_text mit harten Größenobergrenzen; erst die Gliederung, dann Seiten bei Bedarf.

  • 11 MCP-Tools über stdio: list_kbs, create_kb, delete_kb (zweiphasig), add_document, remove_document, get_document, get_document_text, list_documents, search_documents, search_chunks, get_job.

  • In sich geschlossener Speicher: Wissensdatenbanken liegen unter einem einzigen Datenverzeichnis (~/.scholar-rag); Qdrant wird entweder automatisch gestartet (einzelne Binärdatei, versionsgepinnt) oder mit einer externen Instanz verbunden.

Related MCP server: RAG MCP Server

Installation

Erfordert pixi. Vom Repository-Root aus:

pixi install                      # installs the default environment

Das Projekt definiert drei pixi-Umgebungen, die jeweils einem anderen Zweck dienen:

Umgebung

Zweck

default

Kernlaufzeit + Entwicklungs-Tooling (pytest/ruff/mypy). MCP-Server und alle Skripte hier ausführen.

mineru

Fügt MinerU (==3.4.5) plus dessen vollständigen Laufzeit-Stack hinzu (gepinnt transformers<5, torch, onnxruntime, shapely, ...). Für PDF-Parsing und den E2E-Smoke-Test.

local-models

Fügt torch/transformers für In-Process-lokale Modell-Backends hinzu (lädt beim ersten Gebrauch Modellgewichte herunter).

Überprüfen Sie Ihre Umgebung mit dem eingebauten Doctor:

pixi run python scripts/doctor.py

Modellbereitstellung

Die Umgebung ('chat', 'embed' und 'rerank'-Clients) erwartet OpenAI-kompatible HTTP-Endpunkte. scripts/serve_models.sh startet drei vLLM-Instanzen für den Referenzmodellsatz:

Dienst

Modell

Port

chat

Qwen3.5-0.8B

8101

embed

jina-embeddings-v5-text-small

8102

rerank

jina-reranker-v3.5

8103

# point *_MODEL at your local model directories, then:
bash scripts/serve_models.sh

SCHOLAR_RAG_CHAT_MODEL, SCHOLAR_RAG_EMBED_MODEL und SCHOLAR_RAG_RERANK_MODEL sind erforderlich – das Skript beendet sich mit einer Meldung, die sie auflistet, wenn eine nicht gesetzt ist. Jeder Wert muss ein absoluter Pfad zu einem lokalen HuggingFace-Modellverzeichnis sein; vLLM bedient jedes Modell unter einem Kurznamen, der dem Verzeichnis-Basename entspricht, daher müssen die Client-Einstellungen diesen Kurznamen verwenden (der bediente Name entspricht nicht mehr dem vollständigen Pfad). Ersetzen Sie die /path/to/...-Platzhalter in .env.example entsprechend. Ports (CHAT_PORT/EMBED_PORT/RERANK_PORT) und GPU-IDs bleiben optional mit funktionierenden Standardwerten.

Das Skript pinnt die genauen vLLM-Flags, die für diese Modelle verifiziert wurden (das Jina-Embed-Modell benötigt --trust-remote-code für seinen benutzerdefinierten Code; der Reranker läuft mit seiner Standardaufgabe, keine zusätzlichen Flags). Das Laden der Modelle dauert mehrere Minuten; das Skript pollt die Gesundheit, bis alle drei antworten.

Minimale Umgebung

Beginnen Sie mit .env.example und setzen Sie mindestens die Modell-Endpunkte (verwenden Sie die Kurznamen, die das Serve-Skript bereitstellt, gleich dem Basename jedes Modellverzeichnisses):

SCHOLAR_RAG_DATA_DIR=~/.scholar-rag
SCHOLAR_RAG_QDRANT_STORAGE_DIR=~/.local/share/scholar-rag/qdrant

SCHOLAR_RAG_CHAT_BASE_URL=http://127.0.0.1:8101/v1
SCHOLAR_RAG_CHAT_MODEL=Qwen3.5-0.8B

SCHOLAR_RAG_EMBED_BASE_URL=http://127.0.0.1:8102/v1
SCHOLAR_RAG_EMBED_MODEL=jina-embeddings-v5-text-small

SCHOLAR_RAG_RERANK_BASE_URL=http://127.0.0.1:8103/v1
SCHOLAR_RAG_RERANK_MODEL=jina-reranker-v3.5

Die Embed-Modell-Dimension wird bei der KB-Erstellung in kb_meta.json aufgezeichnet, sodass ein späterer Wechsel des Embedding-Modells eine neue KB erfordert.

MCP-Client-Einrichtung

Starten Sie den Server-Einstiegspunkt direkt, um sicherzustellen, dass er läuft:

pixi run scholar-rag-mcp

Claude (Claude Desktop / claude CLI)

{
  "mcpServers": {
    "scholar-rag-mcp": {
      "command": "pixi",
      "args": ["run", "scholar-rag-mcp"]
    }
  }
}

opencode

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "scholar-rag-mcp": {
      "type": "local",
      "command": ["pixi", "run", "scholar-rag-mcp"]
    }
  }
}

Tools

Tool

Zweck

list_kbs

Wissensdatenbanken mit Dokument-/Chunk-Anzahl und Status auflisten.

create_kb

Asynchron jedes PDF in einem Ordner in eine neue KB aufnehmen (gibt job_id zurück).

delete_kb

Zweiphasige KB-Löschung (siehe unten).

add_document

Asynchron ein einzelnes PDF in eine bestehende KB aufnehmen (gibt job_id zurück).

remove_document

Synchron ein Dokument löschen (Qdrant-Punkte + Katalog + Dateien).

get_document

Dokumentübersicht: Metadaten, Abstract, Abschnittsgliederung, Gesamtgröße.

get_document_text

Paginiertes Volltextlesen eines Dokuments oder eines einzelnen Abschnitts.

list_documents

Paginiertes Durchsuchen von Dokumenten in einer KB.

search_documents

PubMed-artige Dokumentebene-Suche (FTS + Titel/Autoren/Journal/Jahr).

search_chunks

Semantische Chunk-Suche mit Metadatenfiltern und Embed+Re-Rank-Scores.

get_job

Status/Fortschritt/Ergebnis/verstrichene Zeit eines Hintergrundjobs abfragen.

Datenlayout

<data_dir>/                     # SCHOLAR_RAG_DATA_DIR, default ~/.scholar-rag
├── kbs/<kb_name>/
│   ├── kb_meta.json            # dimension, chunk config, schema version
│   ├── catalog.sqlite3         # documents / authors / keywords / chunks + FTS5
│   └── documents/<doc_id>/     # source.pdf, full_text.md, sections.json
├── cache/parse/                # MinerU markdown cache, keyed by content hash
├── cache/resolver/             # annotation resolver cache, keyed by content hash
├── jobs.sqlite3                # async job history
└── bin/                        # auto-downloaded Qdrant binary (v1.12.5)

Qdrant-Speicher liegt außerhalb von data_dir unter QDRANT_STORAGE_DIR (Standard ~/.local/share/scholar-rag/qdrant) – er muss auf einem lokalen Dateisystem liegen, nicht auf einem 9p/Netzwerk-Mount.

Zweiphasige KB-Löschung

delete_kb löscht beim ersten Aufruf mit falschen Argumenten nie versehentlich:

  1. Rufen Sie delete_kb(kb="...") auf – gibt KB-Statistiken plus ein 10-minütiges confirm_token zurück.

  2. Rufen Sie delete_kb(kb="...", confirm_token="<token>") auf, um tatsächlich die Qdrant-Sammlung, das KB-Verzeichnis und dessen Job-Verlauf zu löschen.

Entwicklung

pixi run lint          # ruff check src tests
pixi run typecheck     # mypy src
pixi run test          # pytest (unit + integration, no e2e/perf)
pixi run -e mineru pytest tests/e2e/smoke.py -v -m e2e   # real end-to-end smoke
python tests/perf/bench_query.py                          # query latency benchmark (writes docs/perf-report.md)

Versionshinweise

Für bekannte Einschränkungen und Upgrade-Anleitung siehe docs/handoffs/release-notes-v0.1.0.md.

Bekannte Einschränkungen, die es wert sind, wiederholt zu werden:

  • Qdrant ist auf v1.12.5 gepinnt – es ist die höchste Version, die auf glibc 2.35 läuft; Auto-Start lädt es beim ersten Gebrauch herunter. Auf glibc >= 2.38 können Sie eine neuere Version ausführen, aber das Datenformat ist nicht vorwärtskompatibel mit älteren KBs in dieser Version.

  • MinerU läuft in seiner eigenen pixi-Umgebung, weil seine transformers-Version sich gegenseitig mit der vLLM-Version ausschließt. PDF-Parsing bevorzugt daher pixi run -e mineru.

  • MinerU-Gewichte (~3,2 GB) werden beim ersten Parsen in ~/.cache/modelscope/ heruntergeladen.

  • Metadaten-Titel-Heuristik: Titel werden nur lokal ausgewählt, wenn das MinerU-Markdown mit einer #/##-Überschrift beginnt, sodass ein führendes ## Abstract (usw.) als Titel fehlinterpretiert werden kann. Dies betrifft nur die lokale Heuristik-Metadatenstufe; die CrossRef-Stufe (verwendet, wenn eine DOI gefunden wird) korrigiert dies normalerweise.

  • Tool-Dispatch: Unbekannte zusätzliche Argumente für ein Tool werden stillschweigend ignoriert statt abgelehnt.

  • 9p-Speicherlimit: Qdrant-Speicher muss auf einem lokalen Dateisystem liegen.

Available Tools

11 tools
add_documentA

Asynchronously ingest a single PDF into an existing kb; returns a job_id.

ParametersJSON Schema
NameRequiredDescriptionDefault
kbYes
pdf_pathYes

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description must carry the behavioral burden; it does disclose the key fact that ingestion is asynchronous and returns a job_id. However, it does not explain job lifecycle, whether the operation is idempotent, or what failure/error behavior the agent should expect.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence front-loads the essential behavior and return type with no filler; every element earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter tool with an output schema, the description is mostly sufficient, but it misses the async workflow link: an agent is told it gets a job_id but not advised to poll get_job or that ingestion completion is part of that flow.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must compensate. It maps kb to an existing target and pdf_path to a single PDF, but adds little beyond the self-explanatory parameter names and leaves path format/kb identifier details unspecified.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description names a specific verb ('ingest'), object ('a single PDF'), destination ('existing kb'), and execution mode ('asynchronously'), while noting the job_id return. This clearly separates it from retrieval, removal, search, and KB-lifecycle sibling tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'into an existing kb' implies this is only appropriate when the target kb already exists, but there is no explicit when/when-not guidance or link to alternatives such as create_kb (if the kb doesn't exist) or get_job (to track the returned job_id).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_kbA

Asynchronously create a kb from all PDFs in a folder; returns a job_id.

ParametersJSON Schema
NameRequiredDescriptionDefault
kb_nameYes
chunk_maxNo
chunk_minNo
folder_pathYes
chunk_overlapNo
skip_existingNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the behavioral burden. It usefully discloses that creation is asynchronous and that a job_id is returned, which is essential operational information. However, it does not mention failure behavior, required access to the folder, side effects, or that the job can be tracked via get_job.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence packs the core purpose, the source scope, the async nature, and the return value without any filler. Every word earns its place and the most decision-relevant information comes first.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For the required parameters, the description plus schema names are sufficient to make a basic call. However, with 6 parameters, no annotations, and no mention of chunking semantics or job monitoring via get_job, the description is only minimally complete for a tool of this complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

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 only clarifies the meaning of folder_path (a folder of PDFs) and loosely implies kb_name names the KB. The chunk_max, chunk_min, chunk_overlap, and skip_existing parameters receive no semantic explanation, leaving a significant gap for a six-parameter tool.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('create'), a clear resource ('kb'), a precise source scope ('all PDFs in a folder'), and a notable execution trait (async + job_id). This distinguishes it from sibling tools like add_document, which handles individual documents, and delete_kb, which removes a KB.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly implies when to use the tool: when you want to build a knowledge base from a bulk set of PDFs in a folder rather than adding documents one by one. It does not explicitly name alternatives or state when not to use it, but the folder-scoped wording is contextually strong enough.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

delete_kbB

Two-phase kb deletion: preview and confirm token, else full deletion.

ParametersJSON Schema
NameRequiredDescriptionDefault
kbYes
confirm_tokenNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the behavioral burden. It does disclose the key behavior: deletion requires a two-phase preview-and-confirm token flow. However, it omits consequences of an invalid token, irreversibility, permissions, or whether the first call actually deletes anything.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is one short sentence with no filler and is front-loaded with the key operation. The ambiguous closing phrase 'else full deletion' slightly detracts from an otherwise efficient structure.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description captures the essential two-phase workflow but leaves operational details unclear, such as the exact flow between preview and confirmation and the meaning of 'full deletion.' The presence of an output schema helps, but for a destructive tool with no annotations, more explicit guidance would be valuable.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

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 partially does by explaining confirm_token as the confirmation mechanism, but it does not explain what kb should contain or how the token is obtained. The meaning is mostly inferred from the tool name and context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies the operation as knowledge base deletion and names the two-phase workflow. The trailing 'else full deletion' is ambiguous about when preview vs. full deletion occurs, but the core purpose is still understandable and distinct from sibling document tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies a two-step usage pattern: first preview, then confirm with a token. It does not explicitly state when to use this tool over remove_document or how the phases should be sequenced, leaving some inference to the agent.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_documentB

Overview of a document: metadata, abstract, section outline and total character count.

ParametersJSON Schema
NameRequiredDescriptionDefault
kbYes
doc_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of disclosing behavior. It does disclose the output composition, which is useful, and 'get' implies a read operation. However, it does not state whether the operation is read-only, what happens on missing documents, or whether it excludes full text beyond the term 'Overview'.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence where every phrase adds meaning. It starts with the core purpose and then lists concrete contents without any filler or repetition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The presence of an output schema covers return-value documentation, and the tool is relatively simple. Still, with no usage guidance and no parameter semantics in the description, an agent selecting between get_document and get_document_text has incomplete context to make a confident choice.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, and the description does not explain what kb or doc_id mean beyond their generic names and titles. An agent must infer that kb identifies a knowledge base and doc_id identifies the target document, which is not explicitly communicated.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific operation, 'Overview of a document', and enumerates exactly what is returned: metadata, abstract, section outline, and total character count. This clearly distinguishes it from sibling get_document_text, which presumably returns full text.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no explicit when-to-use or when-not-to-use guidance and does not mention alternatives such as get_document_text or search_documents. The intended use case is only implied by the word 'Overview', leaving the agent to infer which sibling tool is appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_document_textB

Paginated reading of the full text or a single section of a document.

ParametersJSON Schema
NameRequiredDescriptionDefault
kbYes
pageNo
doc_idYes
sectionNo
page_sizeNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden. It does disclose that the operation is a read and that pagination is involved, plus the full-text-vs-section behavior. However, it omits important behavioral details such as how pagination terminates, what page_size represents, what happens for missing sections, and whether only the readable text is returned.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, direct sentence that front-loads the primary behavior and includes the most important scope distinction. There is no filler or redundant restatement of the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The schema and output schema provide some structural context, but the description remains thin for a 5-parameter tool with no annotations. It gives a reasonable high-level orientation, but does not cover pagination mechanics, parameter usage, or alternative tool selection, so it is not fully complete for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description needed to explain the parameters, but it does not mention kb, doc_id, page, or page_size explicitly. It hints at the section parameter ('a single section') and at pagination generally, but it does not clarify parameter relationships, defaults, or constraints enough to compensate for the absent schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('reading'), the resource ('text of a document'), and a key scope distinction ('full text or a single section'). It is specific enough to convey the core purpose, though it does not explicitly distinguish itself from the sibling get_document tool.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is given about when to use this tool versus alternatives like get_document or search_chunks. There is no mention of prerequisites, typical use cases, or when to prefer another sibling, so an agent must infer the appropriate selection.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_jobA

Query the status, progress and result of a background job.

ParametersJSON Schema
NameRequiredDescriptionDefault
job_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description must carry behavioral transparency on its own. It does convey that the operation is a read via 'Query' and that it returns status/progress/result, but it does not disclose what happens if the job is not found, whether it returns immediately, or whether it can be called repeatedly. This is adequate but not rich.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, front-loaded sentence with zero filler. Every word carries meaning, covering the verb, resource, and expected output fields.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple one-parameter read tool with an output schema, the description is mostly sufficient: it states the operation's purpose and the schema handles the argument definition. It only lacks explicit guidance on when job polling is appropriate, but that is a usage nuance rather than a blocking gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% and the description does not mention job_id at all, so it fails to compensate for the low coverage. However, the parameter's name ('job_id') and title ('Job Id') make its purpose self-evident, so the lack of additional meaning is a minor but real gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses the specific verb 'Query' and identifies the resource as 'a background job', then enumerates exactly what is returned: status, progress, and result. This clearly distinguishes it from sibling tools focused on documents and KBs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies use when a caller needs job status or progress, but it doesn't state when to use it versus alternatives, mention polling behavior, or explain its relationship to the document/KB tools. Usage context is left to the agent to infer.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_documentsC

Paginated browse of documents in a kb.

ParametersJSON Schema
NameRequiredDescriptionDefault
kbYes
pageNo
sortNoadded
page_sizeNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden of behavioral disclosure. It only reveals pagination; it does not state read-only status, default sort order, error behavior on missing kb, or whether results are limited to metadata. Minimal behavioral context is provided.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence with no filler, front-loading the verb 'browse'. It is appropriately short for a list operation, though it sacrifices some informational depth.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given 4 parameters, 0% schema description coverage, and no annotations, this description is too sparse to be complete. The output schema covers return values, but parameter meanings, usage context, and behavioral specifics are largely absent. An agent would need to infer too much.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

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 for parameter meanings. It clarifies that kb is a knowledge base and hints at pagination, but provides no detail on 'sort', 'page', or 'page_size' semantics beyond what the schema's titles already show.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states a specific verb ('browse') and resource ('documents in a kb'), with pagination noted. It is distinguished from siblings like get_document or search_documents by the word 'browse', though it doesn't specify whether it returns metadata or full content.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool vs alternatives. The word 'browse' implies a listing use case, but there are no exclusions, prerequisites, or comparisons to search_documents or get_document.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_kbsA

List all knowledge bases with metadata and status.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden. It states that the tool returns all KBs and includes metadata and status, which gives some idea of the operation's scope and output. It does not mention whether the operation is read-only, whether it might be paginated, or any rate limits, though 'list' inherently suggests a non-mutating read. Lacks detail on behavioral edge cases.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, compact sentence that front-loads the verb and object, then adds the output characteristics. Every word earns its place, and there is no redundant verbiage or repetition of schema details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-argument list operation with an output schema, the description fully covers what the tool does, at what scope, and what the response contains. No additional context about return values is needed because the output schema exists. The tool is simple enough that nothing essential is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters and the schema is empty, so there is nothing for the description to clarify on a per-parameter basis. The phrase 'all knowledge bases' adds a useful scope clarification, confirming there are no filter or pagination parameters. This meets the baseline expectation for a 0-parameter tool.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('List') and resource ('knowledge bases') and clearly states the scope ('all') and the content returned ('metadata and status'). This distinguishes it from sibling tools like create_kb and delete_kb, as well as document-specific tools, without needing to inspect schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The purpose strongly implies when to use the tool: when you need an overview of all knowledge bases and their state. However, there is no explicit guidance about when not to use it or how it compares to alternatives such as get_document or search_documents. For a simple list operation, the implied usage is acceptable but not fully explicit.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

remove_documentB

Synchronously delete a document from qdrant, catalog and disk.

ParametersJSON Schema
NameRequiredDescriptionDefault
kbYes
doc_idYes

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

B3.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the burden of behavioral disclosure. It does communicate the destructive scope and that deletion is synchronous across multiple stores, but it does not mention whether the operation is irreversible, what happens if the document does not exist, or 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is one efficient, front-loaded sentence. It conveys the operation, the synchronous behavior, and the affected storage locations without waste.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive tool with no annotations and two required parameters, the description is not complete enough. It omits parameter semantics, safety caveats, and behavior in failure cases, though an output schema is present.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, and the description does not explain either parameter. 'kb' and 'doc_id' are left entirely to inference from their names, with no guidance on formats, relationships, or how to obtain valid values.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: 'delete a document' along with the concrete stores affected: qdrant, catalog, and disk. This clearly differentiates it from document retrieval/search tools and from KB-level deletes like delete_kb.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives no explicit guidance on when to use this tool versus alternatives, nor any exclusions or prerequisites. Usage is only implied by the name and the verb 'delete,' with no context about preparing for the operation or handling the irreversibility.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_chunksA

Semantic search over chunk bodies of a kb with metadata filters, embedding and rerank scores.

ParametersJSON Schema
NameRequiredDescriptionDefault
kbYes
queryYes
top_kNo
min_scoreNo
metadata_filterNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the behavioral burden, and it discloses that the operation is semantic, filterable by metadata, and produces embedding and rerank scores. It does not overstate side effects; search implies a read operation. It could add detail on how filters and scores interact, but the core behavior is clearly conveyed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single dense sentence that leads with the action and target and ends with scoring detail. There is no filler or repetition of schema field titles.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The presence of an output schema covers return values, but the description still leaves parameter semantics and the relationship to search_documents implicit. For a straightforward search operation the description is adequate, yet it has clear gaps around top_k/min_score and when to use this tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

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 for five otherwise undocumented parameters. Only 'metadata filters' maps directly to a parameter; kb/query semantics are implicit, and top_k/min_score are not explained at all.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb ('search'), resource ('chunk bodies of a kb'), and retrieval type ('semantic'), with metadata filtering noted. This clearly distinguishes it from sibling search_documents, which operates at document level.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'semantic search over chunk bodies' implies this is the right tool when an agent needs similarity-based retrieval over chunks, in contrast to sibling document-level tools. However, it never explicitly states when to prefer this tool over search_documents or when not to use it, so usage guidance is only implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_documentsC

Document-level PubMed-style search with optional FTS query and metadata filters.

ParametersJSON Schema
NameRequiredDescriptionDefault
kbYes
pageNo
queryNo
titleNo
authorsNo
journalNo
year_toNo
page_sizeNo
year_fromNo

Output Schema

ParametersJSON Schema
NameRequiredDescription

No output parameters

TDQS

C2.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden of behavioral disclosure. It states search scope and optional filters but does not explain whether the operation is read-only, how filters combine, how pagination behaves, or what query syntax is expected. 'PubMed-style' hints at behavior but is not explicit.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single front-loaded sentence with no filler. Every phrase contributes to the core purpose or key capability, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 9 parameters, no annotations, and zero schema descriptions, one sentence is not enough. The output schema may cover return values, but the description omits query syntax, filter semantics, pagination behavior, and sibling selection cues, leaving significant gaps for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

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 adds useful meaning by labeling 'query' as an FTS query and grouping title, authors, journal, and year fields as metadata filters. However, it does not clarify query syntax, filter combination logic, or the meaning of kb/page/page_size beyond their names.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly identifies 'search' as the action and 'documents' as the resource, and 'document-level' helps separate it from chunk-level searching. It does not explicitly name sibling alternatives such as list_documents, but the core purpose is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies use for finding documents via full-text query and metadata filters, but it offers no explicit when-to-use guidance, no exclusions, and no comparison with search_chunks or list_documents. An agent is left to infer when this tool is the right choice.

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.

  1. 11 tool updatesv0.1.0
    • First observedadd_document
    • First observedcreate_kb
    • First observeddelete_kb
    • First observedget_document
    • First observedget_document_text
    • First observedget_job
    • First observedlist_documents
    • First observedlist_kbs
    • First observedremove_document
    • First observedsearch_chunks
    • First observedsearch_documents

TDQS

A3.7/5.0

Scored across 11 tools

Disambiguation5/5

Each tool targets a distinct resource and action: KB-level, document-level, and chunk-level operations are cleanly separated. get_document versus get_document_text, and search_documents versus search_chunks, are differentiated by granularity and description.

Naming Consistency5/5

All tools follow a clear snake_case verb_noun pattern (get, add, remove, search, list, create, delete). The only slight abbreviation is list_kbs, but it does not break the pattern or create ambiguity.

Tool Count5/5

At 11 tools, the surface is well-scoped for a RAG/knowledge-base server: KB management, document management, retrieval, and job status. Each tool corresponds to a distinct operation needed for the workflow.

Completeness5/5

The set covers the full lifecycle: KB create/list/delete, document add/get/list/remove, text reading, document- and chunk-level search, and async job tracking. There are no obvious dead ends; asynchronous operations are paired with get_job for status and results.

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • F
    license
    Not graded
    quality
    D
    maintenance
    A local academic research assistant that indexes PDFs into a searchable vector library and exposes MCP tools for semantic search, claim extraction, contradiction detection, and multi-step research synthesis.
    -
  • F
    license
    A
    quality
    B
    maintenance
    Enables semantic search across personal PDF paper collections with page-level citations, allowing users to query their library from any MCP-capable client.
    9
    -