3gpp-mcp
3gpp-mcp
Ein MCP-Server (Model Context Protocol), der LLMs den Zugriff auf 3GPP-Spezifikationen ermöglicht.
Hintergrund
3GPP-Spezifikationen sind unverzichtbare Referenzen für die Mobilfunk- und Telekommunikationstechnik, aber für LLMs sind sie nur schwer effektiv nutzbar:
Zu viele Dokumente – Tausende von Spezifikationen existieren über mehrere Reihen hinweg, was es schwierig macht, die richtige zu finden.
Einzelne Dokumente sind zu groß – Viele Spezifikationen sind hunderte Seiten lang und überschreiten typische Kontextfenster bei Weitem.
Verteilung als Word-Dateien – Spezifikationen werden im
.docx/.doc-Format veröffentlicht und müssen für die Textverarbeitung konvertiert werden.Starke Querverweise – Spezifikationen verweisen häufig aufeinander; das Lesen eines einzelnen Dokuments isoliert ergibt ein unvollständiges Bild.
Informationen in Tabellen und Abbildungen – Komplexe Tabellen und Ablaufdiagramme enthalten kritische Details. Dieses Tool konvertiert Tabellen in Markdown und extrahiert eingebettete Bilder zur Ansicht durch LLMs.
Versionskomplexität – Dieselbe Spezifikation existiert in mehreren 3GPP-Releases, und die Identifizierung der richtigen Version ist wichtig.
Dieses Tool adressiert diese Herausforderungen, indem es die .docx-Dateien analysiert, den Inhalt nach Abschnitten strukturiert und alles in einer SQLite-Datenbank mit Volltextsuche (FTS5) speichert. Ein MCP-Server stellt dann Werkzeuge zur Suche, zum Navigieren nach Abschnitten und zum Verfolgen von Querverweisen bereit – so kann ein LLM die Spezifikationen wie ein Ingenieur durchsuchen.
Warum nicht RAG?
Embedding-basiertes RAG ist eine gängige Methode zur Verbesserung der Genauigkeit bei Dokumenten-Fragen und -Antworten, und es gibt spezialisierte RAG-Systeme für 3GPP-Dokumente (Telco-RAG, TelcoAI). Dieses Tool verfolgt einen einfacheren Ansatz: Statt einer Retrieval-Pipeline vor dem Modell gibt es dem Modell Such- und Navigationswerkzeuge und lässt es die Spezifikationen so erkunden, wie ein Ingenieur es tun würde – Volltextsuche, dann folgt es der Abschnittshierarchie und den Querverweisen. Da die Abfrage eine einfache FTS5-Suche über strukturierte Abschnitte ist, wird kein Embedding-Modell oder Vektordatenbank benötigt, und alles lebt in einer einzigen SQLite-Datei.
Gemessen an TeleQnA verbessert dies die Genauigkeit bei Fragen zu 3GPP-Standards um 6,5 bis 12,0 Prozentpunkte über drei Modellfamilien hinweg. Der größte Teil davon kommt durch den reinen Text: eine einzelne BM25-Abfrage über dieselbe Datenbank macht +7,8 bis +9,6 Punkte davon aus. Die eigene Suche des Tools ist es, was sie bei Fragen unterscheidet, deren Antwort mehr als einen Sprung von der ersten abgerufenen Passage entfernt ist – bei Aufgaben, die aus den Spezifikationen selbst generiert wurden (Protokollcodes, ASN.1-Struktur, 5G-SBI-Schemata), beantwortet es die Fragen und zitiert korrekt in 88–100 % der Fälle und schlägt dieselbe BM25-Baseline bei jedem Aufgabentyp und jedem Modell um +26 bis +88 Punkte. Siehe BENCHMARK.md.
Related MCP server: mcp-docs
Erste Schritte
1. Installation
# Homebrew
brew install higebu/tap/3gpp-mcp
# ...or with Go 1.26+
go install github.com/higebu/3gpp-mcp/cmd/3gpp-mcp@latestVorgefertigte Binärdateien sind auch auf der Releases-Seite verfügbar. LibreOffice ist optional (erforderlich für die Konvertierung von .doc in .docx und die Konvertierung von EMF/WMF-Bildern in PNG).
2. Datenbank erstellen
Laden Sie Spezifikationen herunter und importieren Sie sie in die Datenbank. Temporäre Dateien werden nach der Verarbeitung jeder Spezifikation gelöscht, um die Festplattennutzung zu minimieren.
# Download and import the latest version of every spec (all releases)
3gpp-mcp build --latest --db data/3gpp.db --convert-doc --convert-image
# ...or restrict to a single release
3gpp-mcp build --release 19 --db data/3gpp.db --convert-doc --convert-imageDies durchsucht das 3GPP-FTP-Archiv, lädt ZIP-Dateien herunter, extrahiert und analysiert .docx-Dateien und fügt strukturierte Inhalte in die SQLite-Datenbank ein.
3. Bei Ihrem MCP-Client registrieren
Claude Code
claude mcp add --scope user 3gpp -- 3gpp-mcp serve --db /path/to/data/3gpp.dbVS Code / GitHub Copilot
code --add-mcp '{"name":"3gpp","command":"3gpp-mcp","args":["serve","--db","/path/to/data/3gpp.db"]}'GitHub Copilot CLI
Fügen Sie zu ~/.config/github-copilot/cli-mcp.json hinzu (erstellen, falls nicht vorhanden):
{
"mcpServers": {
"3gpp": {
"command": "3gpp-mcp",
"args": ["serve", "--db", "/path/to/data/3gpp.db"]
}
}
}Codex CLI
codex mcp add --name 3gpp --command 3gpp-mcp --args serve --db /path/to/data/3gpp.dbClaude Desktop
Fügen Sie zu Ihrer Konfigurationsdatei hinzu (~/Library/Application Support/Claude/claude_desktop_config.json auf macOS, %APPDATA%\Claude\claude_desktop_config.json auf Windows):
{
"mcpServers": {
"3gpp": {
"command": "3gpp-mcp",
"args": ["serve", "--db", "/path/to/data/3gpp.db"]
}
}
}4. Web-Viewer (optional)
Durchsuchen Sie Spezifikationen in Ihrem Browser, indem Sie --web zum HTTP-Transport hinzufügen:
3gpp-mcp serve --db data/3gpp.db --transport http --addr :8080 --web
# MCP endpoint: http://localhost:8080/mcp/
# Web viewer: http://localhost:8080/Funktionen: Spezifikationsliste mit Filterung, Abschnittsansicht mit Inhaltsverzeichnis-Seitenleiste, Volltextsuche mit Paginierung, Durchsuchen vergangener Versionen (Versionen werden pro Spezifikation aufgelistet und bei Bedarf heruntergeladen, wie die MCP-Werkzeuge), Versionsvergleich (strukturelle Zusammenfassung und abschnittsweise Unterschiede), eingebettete Bilder, Querverweis-Links, OpenAPI-Definitionen mit Syntaxhervorhebung, KaTeX-Rendering der LaTeX-Formeln, die der Konverter ausgibt, Dunkelmodus, responsives Design. Codeblöcke werden je nach Notation syntaxhervorgehoben – ASN.1, Diameter, SIP/RTSP, SDP und XML (siehe Codeblöcke).
WebMCP
Wenn der Browser die W3C WebMCP-API bereitstellt (document.modelContext, eine Chrome Origin-Trial ab 2026), registriert der Viewer beim Seitenladen alle seine MCP-Werkzeuge beim Browser, sodass ein In-Browser-Agent direkt die Spezifikationsdatenbank abfragen kann. Die Registrierung ist ein dünner Same-Origin-Passthrough zum /mcp/-Endpunkt – es gibt nichts serverseitig zu konfigurieren, und Browser ohne die API sind nicht betroffen. Während des Origin-Trials aktivieren Sie es lokal über Chrome-Flags (chrome://flags) oder für eine gemeinsame Bereitstellung stellen Sie einen Origin-Trial-Header von einem vorgelagerten Proxy bereit.
Bereitstellung
Streamable HTTP
Der HTTP-Transport ist zustandslos: Er unterstützt das MCP-Protokoll Version 2026-07-28 (kein Initialize-Handshake, keine Mcp-Session-Id), während ältere Clients (2024-11-05 bis 2025-11-25) weiterhin über anfragebezogene Sessions funktionieren.
Starten Sie den Server mit HTTP-Transport:
3gpp-mcp serve --db data/3gpp.db --transport http --addr :8080Optional Bearer-Token-Authentifizierung aktivieren:
export THREEGPP_MCP_BEARER_TOKEN=$(openssl rand -hex 32)
3gpp-mcp serve --db data/3gpp.db --transport http --addr :8080Konfigurieren Sie dann Ihren Client für die Verbindung über HTTP:
{
"mcpServers": {
"3gpp": {
"url": "http://your-server:8080",
"headers": {
"Authorization": "Bearer YOUR_SECRET_TOKEN"
}
}
}
}Bei Verwendung von --web verschiebt sich der MCP-Endpunkt nach /mcp/.
Siehe examples/systemd/ für die Produktionsbereitstellung mit systemd.
Docker
Das Dockerfile ist mehrstufig und erstellt die Datenbank direkt für ein Release, wodurch ein eigenständiges Image mit der SQLite-Datenbank (Abschnitte, OpenAPI-Definitionen und eingebettete Bilder) entsteht. Es wird keine vorgefertigte Datenbank im Build-Kontext benötigt.
# Build an image with the latest version of every spec baked in (default)
docker build -t 3gpp-mcp:latest .
# ...or restrict the database to a single release
docker build --build-arg RELEASE=19 -t 3gpp-mcp:rel19 .
# ...or cap the newest release, keeping specs that have no version in it
docker build --build-arg MAX_RELEASE=19 -t 3gpp-mcp:max-rel19 .
# stdio transport (Claude Code / IDE integration)
docker run --rm -i 3gpp-mcp:latest
# HTTP transport
docker run --rm -p 8080:8080 3gpp-mcp:latest serve --db /3gpp.db --transport http --addr :8080RELEASE standardmäßig auf latest, was die neueste Version jeder Spezifikation über alle Releases hinweg einbaut. Setzen Sie --build-arg RELEASE=<n> (z.B. 19), um die Datenbank auf ein einzelnes Release zu beschränken, oder --build-arg MAX_RELEASE=<n>, um das neueste Release zu begrenzen, ohne Spezifikationen fallen zu lassen, die keine Version darin haben. Beide können nicht kombiniert werden.
Cloud Run
Informationen zur Ausführung auf Cloud Run finden Sie in cloudbuild.yaml (Build + Push + Deploy) und service.yaml (Cloud Run-Dienstspezifikation).
Werkzeuge
Jedes unten aufgeführte Werkzeug hat auch einen CLI-Zwilling (list_specs → 3gpp-mcp list-specs und so weiter) für die Shell-Nutzung und Skripterstellung – siehe die Abfragebefehle in der Befehlsreferenz.
Durchsuchen von Spezifikationen
Werkzeug | Beschreibung | Wichtige Parameter |
| Verfügbare Spezifikationen auflisten (paginiert) |
|
| Versionen einer Spezifikation auflisten und wo jede gelesen werden kann |
|
| Inhaltsverzeichnis einer Spezifikation abrufen |
|
| Abschnittsinhalt abrufen (paginiert) |
|
| Zwei Versionen einer Spezifikation vergleichen: strukturelle Zusammenfassung oder Abschnittstext-Diff |
|
Jedes Ergebnis von get_toc, get_section und search nennt die Spezifikation und Version, aus der es stammt, auf jeder Seite einer paginierten Antwort.
Vergangene Versionen
Die Datenbank enthält eine Version pro Spezifikation. Um eine andere Version zu lesen, übergeben Sie version an get_section oder get_toc. version akzeptiert die punktierte Form (15.8.0), das Archiv-Token (f80), einen Release-Selektor (Rel-15 oder 15, wählt die neueste Version in diesem Release) oder latest. Release-Selektoren und latest werden gegen das 3GPP-Archiv aufgelöst, erfordern also On-Demand-Abruf (sie funktionieren nicht unter --no-fetch). old_version und new_version von compare_versions akzeptieren dieselben Formen; new_version standardmäßig auf die Version in der Datenbank.
Eine Version, die nicht in der Datenbank ist, wird aus dem 3GPP-Archiv heruntergeladen und bei der ersten Verwendung konvertiert. Dies dauert bei einer großen Spezifikation bis zu einigen Minuten; wenn es noch läuft, während das Budget des Aufrufs abläuft, sagt das Werkzeug dies und derselbe später wiederholte Aufruf gibt den Inhalt zurück. Ergebnisse werden in einem größenbegrenzten Cache (siehe serve) aufbewahrt, der getrennt von der Hauptdatenbank ist, daher:
searchdeckt nur die Version in der Datenbank ab – herstellerübergreifende Volltextsuche wird nicht unterstütztget_referenceshat nur Daten für die Version in der Datenbank, und ein aus einer archivierten Version gelesener Abschnitt sagt dies in seinem Headerget_imageundlist_imagesakzeptieren ebenfalls eineversion: Bilder einer archivierten Version werden bei ihrer ersten Verwendung heruntergeladen (ein zusätzlicher Archiv-Download pro Version, mit demselben Wiederholungsverhalten), und EMF/WMF-Abbildungen werden in PNG konvertiert, wenn LibreOffice auf dem Server installiert istAbschnittsnummern verschieben sich zwischen Releases; überprüfen Sie
get_tocfür die ältere Version, bevor Sie einen Abschnitt davon lesen
Suche
Werkzeug | Beschreibung | Wichtige Parameter |
| Volltextsuche über alle Spezifikationen |
|
Das search-Werkzeug unterstützt die SQLite FTS5-Abfragesyntax:
Phrasensuche:
"service based interface"Boolesche Operatoren:
AMF AND UE,AMF OR SMF,NOT deprecatedAusschluss nach einem positiven Begriff:
handover -conditionalPräfixübereinstimmung:
handov*Spaltenfilter:
title:authentication,content:handoverNähe:
NEAR(AMF UE, 5)
Begriffe, die Bindestriche oder Punkte enthalten (IMS-AKA, 38.101), werden automatisch in Anführungszeichen gesetzt, sodass kein manuelles Escapen erforderlich ist.
Querverweise
Tool | Beschreibung | Wichtige Parameter |
| Querverweise zwischen Spezifikationen und RFCs abrufen |
|
OpenAPI-Definitionen
Tool | Beschreibung | Wichtige Parameter |
| Verfügbare OpenAPI-Definitionen auflisten |
|
| OpenAPI-Definition abrufen (paginiert) |
|
| Volltextsuche über OpenAPI-Definitionen |
|
search_openapi verwendet einen eigenen FTS5-Index, getrennt von dem, den search verwendet:
search durchsucht Spezifikationsklauseltexte und gibt niemals OpenAPI-Inhalte zurück,
search_openapi durchsucht ausschließlich OpenAPI-Inhalte. Ein Treffer ist eine Definition und nicht ein Dokument – ein Schema aus components.schemas oder eine HTTP-Methode eines Pfades (benannt wie PUT /nf-instances/{nfInstanceID}) – sodass Sie einen Datentyp oder einen Endpunkt finden können, ohne zu wissen, welches API-Dokument ihn definiert, und ihn dann mit get_openapi vollständig lesen können. Eine Abfrage, die ein einzelner nackter Begriff ist, bewertet eine Definition mit genau diesem Namen zuerst, sodass NFProfile das NFProfile-Schema vor den Schemata zurückgibt, die es nur referenzieren.
Der indizierte Text eines Schemas enthält eine Ebene der $ref-Erweiterung – über items und additionalProperties sowie direkt, was der Art und Weise entspricht, wie die 5G-SBI-Definitionen die meisten ihrer Beziehungen darstellen – sodass die Felder eines referenzierten Typs aus dem Schema, das ihn verwendet, durchsuchbar sind; ein zwei Schritte entfernter Typ ist in diesem Text nicht enthalten. Im Gegensatz zu search wendet dieser Index keine Wortstammerweiterung an – Bezeichner werden wie geschrieben abgeglichen – und -, . und _ trennen Token, sodass Nnrf_NFManagement auch durch NFManagement und /nf-instances durch instances gefunden wird. camelCase wird nicht getrennt.
Der Index wird am Ende von build und update erstellt. import und import-dir lassen ihn unberührt: Die YAML-Dateien werden im Archiv-Zip mitgeliefert, sodass das Importieren einer .docx-Datei nicht ändern kann, was es zu indizieren gibt. Eine Datenbank, die vor der Existenz dieses Tools erstellt wurde, hat keinen Index; fügen Sie ihn mit build-openapi-index nachträglich hinzu.
ASN.1-Definitionen
Tool | Beschreibung | Wichtige Parameter |
| Eine ASN.1-Zuweisung nach Namen abrufen – in einer Spezifikation oder über alle hinweg – oder die Zuweisungsnamen einer Spezifikation auflisten |
|
Die ASN.1-spezifizierten Protokolle (RRC TS 38.331/36.331, NGAP TS 38.413, S1AP TS 36.413, XnAP, F1AP, ...) schreiben ihr ASN.1 zwischen -- ASN1START / -- ASN1STOP-Markierungen, die der Konverter als ```asn1-Fences speichert (siehe Codeblöcke). get_asn1 extrahiert jede Zuweisung der obersten Ebene – Typen, Konstanten und Informationsobjekte – aus diesen Fences.
Mit name wird der vollständige Text dieser Zuweisung zusammen mit dem Abschnitt, der sie definiert, zurückgegeben, sodass die Antwort zitiert werden kann. Dies ist wichtig für die Protokolle, die alle ihre IEs in einer Klausel definieren: Die IE-Definitionsklausel von NGAP ist Hunderte von Kilobyte groß, weit mehr als eine get_section-Seite, während die eine Definition, die die Frage beantwortet „Welchen Bereich erlaubt das ASN.1 hier?“, nur wenige Zeilen umfasst. Der Abgleich ignoriert Groß-/Kleinschreibung und Trennzeichen, sodass die IE-Tabelle AMF UE NGAP ID das ASN.1 AMF-UE-NGAP-ID findet; ein Name, der nichts findet, erhält Vorschläge für ähnliche Namen. Ein Name, der mehrfach definiert ist, gibt jede Definition zurück, jede unter ihrer eigenen Quellzeile.
Wenn Sie nicht wissen, welche Spezifikation einen Namen definiert, lassen Sie spec_id weg: Der Name wird über alle Spezifikationen in der Datenbank aufgelöst, aus einem Namensindex, der zur Datenbankerstellungszeit erstellt wird (build, update, import und import-dir aktualisieren ihn alle). Eine Suche, die die falsche Spezifikation angibt, erhält die Information, wo der Name tatsächlich definiert ist. Eine Datenbank, die vor der Existenz dieses Tools erstellt wurde, hat keinen Index – fügen Sie ihn mit build-asn1-index nachträglich hinzu. Die spezifikationsübergreifende Auflösung deckt nur die Datenbankversionen ab – übergeben Sie spec_id (und optional version), um eine archivierte Version zu lesen, mit demselben On-Demand-Download-Verhalten wie get_section.
Mit einer spec_id und ohne name listet es jeden Zuweisungsnamen auf, gruppiert nach dem definierenden Abschnitt.
Eingebettete Bilder
Tool | Beschreibung | Wichtige Parameter |
| Eingebettete Bilder in einer Spezifikation auflisten |
|
| Ein eingebettetes Bild als base64-Daten abrufen, die von LLMs angezeigt werden können |
|
PNG/JPEG/GIF/WebP-Bilder sind direkt von LLMs anzeigbar. EMF/WMF-Bilder (die meisten 3GPP-Abbildungen verwenden dieses Format) werden standardmäßig als Rohdaten gespeichert; verwenden Sie --convert-image, um sie zur Build-Zeit über LibreOffice in PNG zu konvertieren.
Abbildungen werden im Abschnittstext in einer einheitlichen Notation referenziert, unabhängig vom Bildformat:  im Fließtext und <img src="image://NAME?w=&h=" ...> in Tabellenzellen. Übergeben Sie diesen NAME an get_image; sowohl der ursprüngliche Dateiname (image3.emf) als auch der konvertierte (image3.png) werden aufgelöst.
Codeblöcke
Abschnittstexte enthalten getaggte Code-Fences, sodass sowohl LLMs als auch der Web-Viewer die Notationen unterscheiden können:
Fence | Inhalt |
| ASN.1-Module zwischen den |
| Diameter-Befehls- und gruppierte AVP-Definitionen (RFC 6733 CCF) |
| XML-Schemata, XML-Body-Beispiele und DTDs |
| SIP/RTSP-Nachrichtenbeispiele |
| Eigenständige SDP-Sitzungsbeschreibungen |
| Eigenständige Gleichungen, die aus Word-OMML konvertiert wurden |
| Alles andere, was das Quelldokument als Code formatiert |
Formeln
Word-Formeln (OMML) werden in drei Notationen in LaTeX konvertiert, sodass eine Formel lesbar ist, egal ob sie allein steht oder in einem Satz sitzt:
Notation | Wo |
| Ein Absatz, dessen einziger Inhalt eine Gleichung ist. Ihre Gleichungsnummer bleibt als |
| Angezeigte Gleichungen, die kein Fence-Block sein können – innerhalb einer Tabellenzelle oder eines Listeneintrags. |
| Eine Formel innerhalb eines Satzes. |
Einrückung
3GPP-Prosa kodiert Struktur in Einrückungen – verschachtelte Anforderungs- und Bedingungslisten, mehrstufige Definitionen. Der führende Leerraum eines Textabsatzes wird als geschützte Leerzeichen (U+00A0) beibehalten, wobei ein Tabulator des Quelldokuments zu vier wird: Ein wörtlicher Tabulator oder 4+ führende Leerzeichen würden die Zeile in einen eingerückten Codeblock in Markdown verwandeln (in dem HTML wie <sub> nie interpretiert wird), während geschützte Leerzeichen die visuelle Verschachtelung in jedem Renderer erhalten und der Volltextsuche nicht im Weg stehen.
Tipps
Dem Modell sagen, dass es die Tools verwenden soll
Das Anhängen des Servers führt nicht automatisch dazu, dass ein Modell ihn konsultiert: Wenn die Wahl besteht, beantworten einige Modelle 3GPP-Fragen aus dem Gedächtnis. Im Benchmark übersprang Claude Sonnet 5 den Abruf bei 40 % der TeleQnA-Fragen und GPT 5.6 Luna bei 60 %, und bei diesen Fragen waren die Tools wertlos. Ein Satz im System-Prompt des Clients entfernt dieses Ermessen. Die gemessene Formulierung:
Antworten Sie nicht aus dem Gedächtnis. Durchsuchen Sie zuerst die Spezifikationen und stützen Sie Ihre Antwort auf den Text, den Sie abrufen, auch wenn Sie sicher sind, dass Sie die Antwort bereits kennen.
Dieser Satz senkte Lunas Überspringrate auf null und steigerte seinen Gewinn von +5,9 auf +12,0 Punkte, bewegte nichts bei einem Modell, das bereits jede Frage durchsuchte, und ist ohne die angehängten Tools wertlos – es erzwingt den Abruf, anstatt eine Antwort einzuschmuggeln. Strengere Hausregeln im gleichen Geist – stützen Sie jede Antwort über 3GPP auf Klauseltexte, die mit diesen Tools abgerufen wurden, und zitieren Sie die Klausel – sind vernünftig, aber nur der obige Satz ist das, was der Benchmark gemessen hat.
Separate Datenbanken pro Release
Für punktuelle Vergleiche zwischen Releases benötigen compare_versions und der Parameter version keine zusätzliche Einrichtung. Das Erstellen einer separaten Datenbank pro Release lohnt sich dennoch, wenn Sie kontinuierlich mit einem Release arbeiten: Volltext-search, get_references und OpenAPI-Definitionen decken nur die in der Datenbank eingebackene Version ab, sodass eine releasespezifische Datenbank Ihnen alle drei für dieses Release bietet, ohne On-Demand-Downloads.
# Build databases for different releases
3gpp-mcp build --release 18 --db data/3gpp-rel18.db --convert-doc --convert-image
3gpp-mcp build --release 19 --db data/3gpp-rel19.db --convert-doc --convert-image--release behält nur Spezifikationen, die eine Version in genau diesem Release haben, sodass eine in einem früheren Release eingefrorene Spezifikation (z. B. TS 34.108) vollständig in der Datenbank fehlt. Um ein Release festzulegen, ohne diese Spezifikationen zu verlieren, begrenzen Sie stattdessen die Auswahl – jede Spezifikation wird in ihrer neuesten Version auf oder unter der Grenze genommen:
# Everything as of Release 19: specs with no Rel-19 version fall back to their
# newest older version rather than dropping out.
3gpp-mcp build --max-release 19 --db data/3gpp-rel19.db --convert-doc --convert-image
# Keep the cap when refreshing the database later.
3gpp-mcp update --max-release 19 --db data/3gpp-rel19.db --convert-docRegistrieren Sie sie als separate MCP-Server:
claude mcp add --scope user 3gpp-rel18 -- 3gpp-mcp serve --db /path/to/data/3gpp-rel18.db
claude mcp add --scope user 3gpp-rel19 -- 3gpp-mcp serve --db /path/to/data/3gpp-rel19.dbSpezifikationen auf dem neuesten Stand halten
Verwenden Sie den Befehl update, um nach neueren Versionen von Spezifikationen zu suchen, die bereits in Ihrer Datenbank sind:
3gpp-mcp update --db data/3gpp.db --convert-doc --convert-imageBefehlsreferenz
serve
Starten Sie den MCP-Server.
Flag | Beschreibung | Standard |
| Pfad zur SQLite-Datenbank |
|
| Transporttyp: |
|
| HTTP-Listen-Adresse (env: |
|
| Bearer-Token für HTTP-Authentifizierung (env: | |
| Web-Viewer neben dem MCP-Server aktivieren (nur HTTP-Transport) |
|
| On-Demand-Abruf von Spezifikationsversionen, die nicht in der Datenbank sind, deaktivieren |
|
| Pfad zum On-Demand-Versionscache |
|
| Größenbegrenzung des Versionscaches in MB. |
|
| Wie lange ein Tool-Aufruf auf einen On-Demand-Abruf wartet, bevor der Aufrufer um eine Wiederholung gebeten wird (env: |
|
Der Versionscache ist eine separate SQLite-Datei, sodass die Hauptdatenbank schreibgeschützt bleibt und niemals mit zusätzlichen Versionen verunreinigt wird. Wenn der Cache nicht erstellt werden kann – bei einem schreibgeschützten oder flüchtigen Dateisystem, wie dem scratch-basierten Container-Image – protokolliert der Server eine Warnung und läuft mit deaktiviertem On-Demand-Abruf; alles andere funktioniert weiterhin. Zwischengespeicherte Versionen werden nach dem Prinzip „am wenigsten zuletzt verwendet“ entfernt, sobald die Größenbegrenzung überschritten wird.
Der HTTP-Transport stellt auch GET /health bereit, das 200 OK ohne Authentifizierung zurückgibt. Verwenden Sie diesen Pfad für Plattform-Health-Checks (Cloud Run, Sakura AppRun, Kubernetes-Liveness/Readiness-Probes usw.).
build
Spezifikationen herunterladen und in die Datenbank importieren (empfohlen für die Ersteinrichtung). Alias: pipeline.
Flag | Beschreibung | Standard |
| Pfad zur SQLite-Ausgabedatenbank |
|
| Spezifikationen für eine bestimmte Version verarbeiten (z. B. | |
| Die Auswahl auf eine Version begrenzen (z. B. | |
| Jede Spezifikation in ihrer neuesten Version auswählen (verwenden, wenn kein anderer Selektor angegeben ist) |
|
| Eine bestimmte Spezifikation verarbeiten (z. B. | |
| Nach Serie filtern, kommagetrennt (z. B. | |
| Anzahl paralleler Arbeiter | NumCPU |
|
|
|
| EMF/WMF-Bilder mit LibreOffice in PNG konvertieren |
|
| Die Spezifikationsliste aus einer Datei lesen anstatt aus dem Archiv zu scrapen (ein Selektor ist dennoch erforderlich) | |
| Den Spezifikationslistencache deaktivieren |
|
| Nebenläufigkeit für das Scrapen von Spezifikationslisten ( |
|
| HTTP-Timeout |
|
Einer von --release, --max-release, --latest, --series oder --spec muss angegeben werden, einschließlich --spec-list: die Datei liefert die Kandidateinträge und der Selektor filtert sie.
--release und --max-release unterscheiden sich darin, was mit einer Spezifikation passiert, die keine Version in der genannten Version hat: --release 19 verwirft sie, --max-release 19 behält sie in ihrer neuesten Version unterhalb der Grenze. Sie können nicht kombiniert werden.
Andere Befehle
download— Spezifikationen ohne Konvertierung herunterladen (--output-dir, Standardspecs). Erfordert einen von--release,--max-release,--latest,--seriesoder--spec, wiebuild.import— Eine einzelne.docx-Datei in die Datenbank importieren. Alias:convert. Verwendung:3gpp-mcp import --db data/3gpp.db path/to/spec.docximport-dir— Alle.docx-Dateien in einem Verzeichnis in die Datenbank importieren. Alias:convert-dir. Verwendung:3gpp-mcp import-dir --db data/3gpp.db ./specsupdate— Spezifikationen in der Datenbank auf die neuesten Versionen aktualisieren oder auf eine Obergrenze mit--max-release.build-openapi-index— Den OpenAPI-Suchindex einer vorhandenen Datenbank neu erstellen.buildundupdateerledigen dies selbst, daher dient es dem Hinzufügen des Index zu einer Datenbank, die vor der Existenz vonsearch_openapierstellt wurde:serveöffnet die Datenbank schreibgeschützt und kann sie nicht im laufenden Betrieb erstellen.build-asn1-index— Den ASN.1-Namensindex einer vorhandenen Datenbank neu erstellen.build,update,importundimport-direrledigen dies selbst, daher dient es dem Hinzufügen des Index zu einer Datenbank, die vor der Existenz vonget_asn1erstellt wurde.completion— Ein Shell-Vervollständigungsskript ausgeben:3gpp-mcp completion bash(oderzsh,fish)
Die Obergrenze wird nicht in der Datenbank gespeichert, daher benötigt eine mit --max-release 19 erstellte Datenbank dasselbe Flag bei update – andernfalls hebt das Update jede Spezifikation auf die neueste Version im Archiv an. Mit einer Obergrenze verschiebt das Update eine Spezifikation in beide Richtungen, sodass es auch eine bereits erstellte unbegrenzte Datenbank auf die Obergrenze herunterstuft; eine Spezifikation, deren sämtliche Versionen über der Obergrenze liegen, wird entfernt, da keine Version von ihr in eine begrenzte Datenbank gehört. Eine Spezifikation, die in der Archivliste fehlt, wird unberührt gelassen, da eine fehlgeschlagene Liste wie eine zurückgezogene Spezifikation aussieht.
Abfragebefehle
Die Abfragebefehle (list-specs, list-versions, get-toc, get-section,
get-asn1, compare-versions, search, list-openapi, get-openapi,
search-openapi, get-references, list-images, get-image) spiegeln die MCP-Lese-Tools 1:1 wider, sodass
die Datenbank von einer Shell aus ohne MCP-Client überprüft und per Skript gesteuert werden kann:
3gpp-mcp search --db data/3gpp.db --limit 3 "AMF AND authentication" | jq '.results[].section_number'
3gpp-mcp get-section --db data/3gpp.db "TS 23.501" 5.15.2 | lessGemeinsame Konventionen für alle:
Flags müssen vor Positionsargumenten kommen.
JSON-Ergebnisse werden nach stdout eingerückt und ohne Seitenumbrüche ausgegeben – leiten Sie sie an
jq,headoderlessweiter. Warnungen und Fortschrittshinweise gehen an stderr, sodass stdout analysierbar bleibt.Befehle, die
--versionakzeptieren (undcompare-versions), verwenden dieselben Versionsformen wie die MCP-Tools (15.8.0,f80,Rel-15,latest) und warten auf den Abschluss eines On-Demand-Downloads, anstatt Sie um eine Wiederholung zu bitten; unterbrechen Sie mit Strg-C. Sie teilen die Fetch-Flags vonserve:--no-fetch,--version-cache,--version-cache-mb,--fetch-budget. Abfragen, die keine Version nennen, erstellen nie den Versionscache (list-versionsliest einen vorhandenen Cache, um die Verfügbarkeit voncachedzu melden, wird aber keinen erstellen).Jeder Befehl akzeptiert
--db(Standard3gpp.db).
Umgebungsvariablen
Variable | Beschreibung |
| Transport für |
| HTTP-Listen-Adresse für |
| Bearer-Token für HTTP-Transport-Authentifizierung |
| PaaS-Konvention (Cloud Run / Heroku); |
| Größenbegrenzung des On-Demand-Versionscaches in MB (Standard |
| Wie lange ein Tool-Aufruf auf einen On-Demand-Abruf wartet (Standard |
| Maximale ZIP-Download-Größe (Standard |
| TTL des Spezifikationslistencaches in Stunden (Standard |
| Anfänglicher Backoff zwischen den Abrufversuchen der Archivliste in ms (Standard |
| Cache-Verzeichnisstamm, gemäß der XDG Base Directory-Spezifikation |
Available Tools
13 toolscompare_versionsA
Compare two versions of a 3GPP specification. Without section_number, returns a structural summary: sections added, removed, renumbered, retitled, and whose content changed. With section_number, returns a line-level unified diff of that section's text. Use list_versions first to see which versions exist; a version not yet cached is downloaded and converted on first use — when the tool says a download is in progress, call it again with the same arguments.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start line number (0-based, default: 0) | |
| spec_id | Yes | required,Specification ID (e.g. TS 23.501) | |
| max_chars | No | Maximum number of characters to return (can be combined with max_lines) | |
| max_lines | No | Maximum number of lines to return (default: 200) | |
| new_version | No | Newer version to compare to. Defaults to the version in the database. | |
| old_version | Yes | required,Older version to compare from (e.g. 17.9.0). Also accepts an archive token (h90) or a release selector (Rel-17). Use list_versions to see what exists. | |
| context_lines | No | Unchanged lines shown around each change in a section diff (default: 3) | |
| section_number | No | Compare only this section's text as a unified diff (e.g. 5.15.2). Omit for a structural summary of the whole specification. | |
| include_subsections | No | With section_number: include subsections in the diff (default: false) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It transparently discloses that uncached versions trigger a download that may require a second call. It also explains the two output modes. While it doesn't cover all potential edge cases (e.g., error handling), the key behavioral trait is well documented.
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 description is concise: four sentences covering two distinct modes, prerequisites, and first-use behavior. No redundant words. Information is front-loaded with the core purpose.
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?
Given 9 parameters and no output schema, the description is remarkably complete. It explains the two output modes, how to pick versions, and the caching behavior. The only minor gap is that it doesn't describe the format of the structural summary, but that's a niche detail. Overall, it provides sufficient context for correct tool 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 100%, so the baseline is 3. However, the description adds significant context beyond the schema: it explains how 'section_number' changes the output type (summary vs. diff), and gives concrete examples like '5.15.2'. The 'old_version' description also clarifies it accepts archive tokens and release selectors, which is not in the schema. This adds substantial semantic value.
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 starts with 'Compare two versions of a 3GPP specification', clearly defining the verb and resource. It then distinguishes two modes: without section_number (structural summary) and with section_number (line-level diff). This differentiates it from sibling tools like 'get_section' or 'list_versions'.
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 explicitly tells when to use each mode and directs to use 'list_versions first to see which versions exist'. It also explains behavior on first use (download/conversion) and instructs to retry if a download is in progress. This is clear guidance on usage vs. alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_asn1A
Get ASN.1 definitions from the 3GPP specifications. The protocol specifications (RRC TS 38.331/36.331, NGAP TS 38.413, S1AP TS 36.413, XnAP, F1AP, LPP TS 37.355, ...) write their ASN.1 between -- ASN1START / -- ASN1STOP markers, and this tool extracts every top-level assignment from those blocks. With name, it returns the full text of that assignment — type, constant or information object — together with the specification and section that define it, so the answer can be cited. Use it when you know a type, IE or constant name and need its definition or constraints: the defining clause can be hundreds of kilobytes, which get_section can only page through. If you do not know which specification defines the name, omit spec_id — the name is resolved across every specification in the database. Matching ignores case and separators, so an IE table title like 'AMF UE NGAP ID' finds AMF-UE-NGAP-ID. With a spec_id and no name, it lists every assignment name grouped by the section that defines it. Pass version (with spec_id) to read a past version, which is downloaded and converted on first use; call list_versions first to see which versions exist.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ASN.1 assignment name (e.g. AMF-UE-NGAP-ID). Matching ignores case and separators, so an IE title like 'AMF UE NGAP ID' also resolves. Required when spec_id is omitted; with a spec_id, omit it to list every assignment name in the specification. | |
| offset | No | Start line number (0-based, default: 0) | |
| spec_id | No | Specification ID (e.g. TS 38.413). Omit it to look the name up across every specification in the database — use that when you do not know which specification defines the type. | |
| version | No | Specification version to read (e.g. 18.6.0). Also accepts an archive token (i60) or a release selector (Rel-18). Defaults to the version in the database, and requires spec_id. Use list_versions to see what exists. | |
| max_chars | No | Maximum number of characters to return (can be combined with max_lines) | |
| max_lines | No | Maximum number of lines to return (default: 200) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description explains the scope of extraction (only top-level assignments from blocks between ASN1START/ASN1STOP markers), behavior with and without the name parameter, case-insensitive and separator-ignoring matching, and handling of past versions (downloaded and converted on first use). Since no annotations are provided, the description carries full burden, which it largely fulfills, though it could be more explicit about potential limitations (e.g., if the tool is destructive or read-only).
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 description is moderately concise for the amount of information conveyed, but it is somewhat lengthy (multiple sentences). It is front-loaded with the core purpose, then progressively adds details on usage modes, matching behavior, and version handling. Every sentence adds value, but some redundancy could be trimmed (e.g., explaining matching behavior both in the main description and in the parameter description).
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?
Given the tool's complexity (6 parameters, multiple usage modes, no output schema), the description provides comprehensive guidance on how the tool behaves in different scenarios (with/without name, with/without spec_id, with version). It also addresses how to cite results and how to discover versions. The only gap is the lack of information about the return format or output structure, but since there is no output schema, the description could be more explicit about what the tool returns (e.g., structured text, markdown, etc.).
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 100%, so each parameter is already documented in the schema. The description adds extra context beyond the schema, such as the effect of omitting spec_id to search across all specs, the matching behavior (case-insensitive, separator-ignoring), and the fact that name is required when spec_id is omitted. It also explains the version parameter behavior and recommends list_versions. However, since schema coverage is complete, the description exceeds the baseline of 3 but does not substantially add new meaning for every parameter.
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 clearly states the tool extracts ASN.1 definitions from 3GPP specifications, specifying verb ('Get', 'extracts') and resource ('ASN.1 definitions from the 3GPP specifications'). It distinguishes it from siblings like get_section by explaining that the defining clause can be hundreds of kilobytes, which get_section can only page through.
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 explicitly states when to use this tool (e.g., 'Use it when you know a type, IE or constant name and need its definition or constraints') and when to use alternatives (e.g., 'the defining clause can be hundreds of kilobytes, which get_section can only page through'). It also provides guidance on omitting spec_id when the specification is unknown, and directs users to call list_versions first to see available versions.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_imageA
Get an embedded image from a 3GPP specification. Returns the image as base64-encoded data that can be directly viewed by the LLM. Use list_images to discover available images for a spec. Pass version to read a past version's image; the images of an archived version are downloaded on first use, which takes up to a few minutes.
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | required,Image filename (e.g. image1.png) | |
| spec_id | Yes | required,Specification ID (e.g. TS 23.501) | |
| version | No | Specification version to read (e.g. 18.6.0). Also accepts an archive token (i60) or a release selector (Rel-18). Defaults to the version in the database. Use list_versions to see what exists. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden and excels: it states the output is base64-encoded, mentions a latency caveat for archived versions ('up to a few minutes'), and explains the default version behavior. This fully discloses behavioral traits.
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 description is three sentences, front-loaded with the main action and output, and each sentence adds unique value. Could be slightly more concise by combining the first two sentences, but no superfluous content.
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?
Given no output schema and 3 parameters, the description covers tool purpose, input semantics, latency behavior, and next steps via sibling links. It does not mention what happens if parameters are invalid or if an image doesn't exist, but the overall completeness is high for the context.
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 100% and already explains each parameter well. The description adds value by clarifying `version` accepts both version strings and archive tokens, and defaults to the database version, which goes beyond the schema description.
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 uses specific verbs ('Get an embedded image') and resource ('3GPP specification'), and clearly distinguishes this tool from siblings like `list_images` by stating its function and output format.
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 explicitly points to `list_images` for discovering available images and `list_versions` for version discovery, providing clear guidance on when to use alternative tools. However, it does not mention when not to use this tool (e.g., for non-image content).
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_openapiA
Get OpenAPI definition content for 5G service-based interface APIs (TS 29.xxx series). Use this tool to look up HTTP request/response details, API paths, parameters, request bodies, response schemas, and data type definitions. Use the path parameter to filter by API endpoint (e.g. /nf-instances) or the schema parameter to filter by data type (e.g. NFProfile). Use list_openapi first to discover available API names.
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Filter by API path (e.g. /nf-instances) | |
| offset | No | Start line number for pagination (0-based, default: 0) | |
| schema | No | Filter by schema name (e.g. NFProfile) | |
| spec_id | Yes | required,Specification ID (e.g. TS 29.510) | |
| api_name | Yes | required,API name (e.g. Nnrf_NFManagement) | |
| max_lines | No | Maximum lines to return (default: 200) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries full burden. It describes the tool as a 'get' and 'look up' operation, implying it is read-only and non-destructive. However, it does not explicitly state that it is safe, nor does it mention pagination behavior (offset, max_lines) or what happens in edge cases like no results. The description is adequate but lacks explicit behavioral details beyond the verb choice.
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 description is three sentences long, front-loading the purpose in the first sentence and then elaborating on capabilities and usage. Every sentence contributes meaningful information without redundancy or fluff. It is compact and immediately informative.
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 6 parameters, no output schema, and no annotations, the description should provide a thorough understanding of the tool. It covers the main purpose, prerequisite workflow, and parameter usage, but it does not describe the output format (e.g., JSON/YAML), the meaning of offset and max_lines for pagination, or error handling. This leaves gaps in what a user can expect from the tool's response.
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?
The input schema has 100% description coverage, so the baseline is 3. The description adds value by providing concrete examples for the path parameter ('/nf-instances') and schema parameter ('NFProfile'), and by explaining the intended workflow for spec_id and api_name (use list_openapi to discover). This goes beyond the schema's structural descriptions, though it does not cover offset or max_lines.
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 clearly states the tool's purpose: 'Get OpenAPI definition content for 5G service-based interface APIs (TS 29.xxx series).' It distinguishes from siblings like list_openapi by specifying that it retrieves actual definition content, not just listing available APIs. The mention of looking up HTTP request/response details, paths, and schemas further clarifies the specific resource and action.
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 explicitly advises to 'Use list_openapi first to discover available API names,' providing a clear prerequisite and directing to an alternative tool. It also gives specific usage guidance for parameters: 'Use the path parameter to filter by API endpoint (e.g. /nf-instances) or the schema parameter to filter by data type (e.g. NFProfile).' This tells the user exactly when and how to use the tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_referencesA
Get cross-references between 3GPP specifications and RFCs.
Directions:
outgoing (default): Find all specs/RFCs referenced by a given section. Requires spec_id and section_number. Use include_subsections to also gather refs from child sections.
incoming: Find all sections that reference a given spec (and optionally a specific section). Requires spec_id. section_number is optional.
Returns structured reference data including target spec, section, title (if available in DB), and context snippet. Responses are capped at 500 references; a separate notice reports the total, and offset pages through the rest.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Number of references to skip, for paging past a truncated response (default: 0) | |
| spec_id | Yes | required,Specification ID (e.g. TS 23.501) | |
| direction | No | outgoing (default): references FROM this section to other specs. incoming: references TO this spec/section from other specs. | |
| section_number | No | Section number (e.g. 5.1.2). Required for outgoing direction. | |
| include_subsections | No | Include subsections when collecting outgoing references (default: false) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description fully handles behavioral disclosure. It reveals the 500-reference cap, pagination via offset, and that responses include structured data plus a total-count notice. It does not mention rate limits or authorization, but those are not critical for a read-only lookup tool.
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 description is well-structured with clear sections for each direction, uses bullet-style formatting for readability, and every sentence adds essential guidance. No fluff or redundancy.
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?
Given the tool's moderate complexity (5 parameters, two modes), the description covers all necessary details: parameter requirements per mode, default behaviors, response structure, pagination limit, and output format. Without an output schema, it still describes the return data adequately.
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 100%, so the baseline is 3. However, the description adds semantic value beyond the schema by explaining parameter roles in context (e.g., section_number is required for outgoing, optional for incoming) and linking params to use cases (include_subsections only relevant for outgoing).
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 clearly states the tool's purpose: finding cross-references between 3GPP specs and RFCs. It distinguishes two modes (outgoing and incoming) with specific resource targets (specs, RFCs, sections), and the sibling context shows no other tool overlaps with this function.
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 explicitly explains when to use outgoing vs incoming direction, lists required vs optional parameters for each, and notes a default behavior ('outgoing (default)'). It also mentions a cap of 500 references with pagination, guiding the agent on handling large result sets.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_sectionA
Get the markdown content of a specific section in a 3GPP specification. This tool is for reading specification document text (architecture, procedures, requirements). For API details such as HTTP request/response bodies, paths, and data models of 5G service-based interfaces (TS 29.xxx series), use get_openapi instead. Specify the section number with the section_number parameter (e.g. 5.1.2). Figures appear as  links; fetch one with get_image and that NAME. Formulas are LaTeX: a standalone equation is a ```latex code block (its equation number kept as \tag{7.3-1}), and a formula inside a sentence or a table cell is delimited with $...$, or $$...$$ when the source sets it as a display equation. Pass version to read a past version, which is downloaded and converted on first use; call list_versions first to see which versions exist. Large sections are paginated (default 200 lines). Use offset and max_lines to navigate.
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | Start line number (0-based, default: 0) | |
| spec_id | Yes | required,Specification ID (e.g. TS 23.501) | |
| version | No | Specification version to read (e.g. 18.6.0). Also accepts an archive token (i60) or a release selector (Rel-18). Defaults to the version in the database. Use list_versions to see what exists. | |
| max_chars | No | Maximum number of characters to return (can be combined with max_lines) | |
| max_lines | No | Maximum number of lines to return (default: 200) | |
| section_number | Yes | required,Section number to retrieve (e.g. 5.1.2) | |
| include_subsections | No | Include all subsections (default: false) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full responsibility. It transparently explains how figures appear as `` links and how to fetch them with `get_image`, details LaTeX formula formatting (standalone vs. inline), describes version handling (first-use download/conversion), and reveals pagination behavior (default 200 lines). It does not cover error cases or what happens for invalid sections, but the behavioral disclosure is rich and helpful.
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 description is a single paragraph of ~150 words, dense but well-organized. It front-loads the core purpose and sibling distinction, then covers output format, version handling, and pagination. While it could benefit from bullet points or more whitespace for scanning, every sentence adds value and there is no repetition. It is concise for the amount of information conveyed.
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?
Given 7 parameters, 2 required, no output schema, and no annotations, the description covers purpose, usage alternatives, output format (figures, formulas), version behavior, and pagination. It does not describe error handling (e.g., invalid section/spec) or the exact structure of the return value, but it provides enough context for an agent to use the tool effectively in most scenarios.
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 100% (all 7 parameters have descriptions), so baseline is 3. The description adds extra meaning beyond the schema: e.g., for `section_number` it gives an example ('5.1.2'), for `version` it explains the first-use download behavior, and for `offset`/`max_lines` it contextualizes pagination. This additional context improves parameter understanding.
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 clearly states the tool's purpose: 'Get the markdown content of a specific section in a 3GPP specification.' It also specifies the type of content (architecture, procedures, requirements) and explicitly distinguishes from the sibling tool `get_openapi` for API details. The verb 'get' and resource 'section' are specific and 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 description provides direct guidance on when to use this tool vs. `get_openapi` for API details. It advises to call `list_versions` first to check available versions and explains pagination with offset and max_lines. This explicit context helps the agent choose the correct tool and navigate parameters effectively.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_tocA
Get the table of contents (section structure) of a 3GPP specification. Pass version to see the structure of a past version, which is downloaded and converted on first use; section numbers often move between releases, so check the table of contents before reading a section of an older version.
| Name | Required | Description | Default |
|---|---|---|---|
| spec_id | Yes | required,Specification ID (e.g. TS 23.501) | |
| version | No | Specification version to read (e.g. 18.6.0). Also accepts an archive token (i60) or a release selector (Rel-18). Defaults to the version in the database. Use list_versions to see what exists. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full responsibility for behavioral disclosure. It reveals that passing a 'version' triggers a download and conversion on first use, and notes that section numbers often change between releases. These are important behavioral traits. However, it does not state whether the operation is read-only or whether it has any side effects beyond the initial conversion (e.g., caching behavior). The transparency is good but not exhaustive.
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 description is two sentences long, with no wasted words. The first sentence defines the core purpose, and the second sentence adds targeted usage guidance and a behavioral note. Every sentence serves a clear function, and the structure is front-loaded with the most important information.
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?
Given the tool's simplicity (2 parameters, no output schema), the description is nearly complete. It explains what the tool does, the version behavior, and a typical use case. It could be improved by briefly describing the return format (e.g., list of section numbers and titles), but the phrase 'section structure' provides enough context for an agent to infer the output. The absence of an output schema increases the value of a description, and this one is sufficient but not exhaustive.
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 100%, so the baseline is 3. The tool description adds minimal parameter-specific meaning beyond what the schema already provides. It mentions the 'version' parameter's purpose ('see the structure of a past version') and the conversion note, but the schema already describes the parameter's accepted formats and defaults. The description does not enrich the semantics of 'spec_id' beyond what is obvious.
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 clearly states the verb ('Get') and resource ('table of contents (section structure) of a 3GPP specification'). It distinguishes the purpose from siblings like 'get_section' (which reads a specific section) and 'list_versions' (which lists versions). The phrase 'check the table of contents before reading a section' further clarifies its role relative to sibling tools.
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 provides clear usage context: use this tool to inspect the section structure, especially before reading an older version. It warns that section numbers move between releases, implying when to use this tool over others. While it does not explicitly name alternative tools (e.g., 'get_section'), the guidance is direct and actionable. The version parameter description (in schema) adds additional hints like using 'list_versions', which compensates slightly.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_imagesA
List embedded images in a 3GPP specification. Returns image names, MIME types, and whether they are viewable by LLMs. Use get_image to retrieve a specific image. Pass version to list a past version's images; the images of an archived version are downloaded on first use, which takes up to a few minutes.
| Name | Required | Description | Default |
|---|---|---|---|
| spec_id | Yes | required,Specification ID (e.g. TS 23.501) | |
| version | No | Specification version to read (e.g. 18.6.0). Also accepts an archive token (i60) or a release selector (Rel-18). Defaults to the version in the database. Use list_versions to see what exists. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses important behavioral traits such as the latency for archived versions ('takes up to a few minutes') and the defaulting behavior of the version parameter. No annotations are provided, so the description carries the full burden and does so effectively, though it could mention if the list is paginated or has 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 description is concise (three sentences) and well-structured, with the main action upfront, followed by sibling tool reference, and version handling details. Every sentence adds value with no redundancy.
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?
Given the tool has only 2 parameters with full schema descriptions and no output schema, the description covers usage context well. It explains the version parameter's behavior and an edge case (archived version latency). A minor gap is not stating whether the returned list is complete or paginated, but overall it is sufficient for an agent to use the tool correctly.
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?
The input schema provides 100% coverage with descriptions for both parameters, so the baseline is 3. The description adds useful context for the 'version' parameter (e.g., about archive tokens and release selectors) beyond the schema's brief note, but does not add new info for 'spec_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?
The description clearly states the tool's action ('List embedded images in a 3GPP specification') and specifies what it returns ('image names, MIME types, and whether they are viewable by LLMs'). It distinguishes itself from sibling tools like 'get_image' by noting that 'list_images' lists images while 'get_image' retrieves a specific one.
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 provides clear guidance on when to use this tool vs alternatives: 'Use get_image to retrieve a specific image.' It also explains how to handle versions, including past archived versions that may have a delay. However, it does not explicitly mention when not to use it or other exclusions beyond the sibling differentiation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_openapiA
List available OpenAPI definitions from 3GPP specifications (TS 29.xxx series). Use this to discover API names before calling get_openapi. Optionally filter by spec ID.
| Name | Required | Description | Default |
|---|---|---|---|
| spec_id | No | Filter by specification ID (e.g. TS 29.510) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description must carry the full burden. It describes the basic action (listing definitions) and optional filtering, but does not disclose any behavioral traits such as return format, pagination, authentication requirements, or performance implications. For a simple read-only list tool, this is minimally adequate but lacks depth.
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 description consists of two concise sentences. The first sentence defines the action and resource; the second provides usage context and an optional filter. Every phrase earns its place, with no redundancy or unnecessary detail.
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?
Given the low complexity (one optional parameter, no output schema), the description is mostly complete. It links usage to get_openapi and mentions filtering. However, it does not explain the return data shape (e.g., list of API names) or differentiate from other sibling tools like list_specs or search_openapi. Slight room for improvement.
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 100% (the single parameter spec_id has a schema description). The description adds 'Optionally filter by spec ID,' which mirrors the schema. Since the schema already documents the parameter fully, the description adds minimal extra meaning, meeting the baseline for high coverage.
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 clearly states 'List available OpenAPI definitions from 3GPP specifications (TS 29.xxx series).' It uses a specific verb ('list') and resource ('OpenAPI definitions'), and distinguishes from siblings like get_openapi (which gets a specific definition) and list_specs (which lists specs). The context 'discover API names before calling get_openapi' further clarifies its role.
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 explicitly tells when to use the tool: 'Use this to discover API names before calling get_openapi.' It also mentions optional filtering by spec ID. While it does not explicitly state when not to use it or list alternatives (e.g., list_specs), the guidance is clear and contextually useful for an AI agent.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_specsA
List available 3GPP specifications. Optionally filter by series number and/or by an ID prefix (query). Results are paginated (default 20 per page); use limit and offset to navigate.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results to return (default: 20) | |
| query | No | Filter specs whose ID starts with this text (e.g. '38.21' matches 38.211, 38.212, 38.213) | |
| offset | No | Number of results to skip for pagination (default: 0) | |
| series | No | Filter by series number (e.g. 23 for TS 23.xxx) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries full burden for behavioral disclosure. It adds pagination defaults and filter semantics beyond the schema, but does not mention authentication needs, output format, error behavior, or rate limits—leaving significant gaps for a tool with no annotations.
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?
Two efficient sentences: first states purpose, second covers filtering and pagination. No wordiness, front-loaded key information.
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 listing tool with 4 optional parameters and no output schema, the description explains filters and pagination adequately but omits what the response looks like (e.g., fields returned, ordering). Without output schema, the description should hint at the return structure to be fully complete.
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 100%, so baseline is 3. The description adds context that filters can be combined and how pagination works (limit/offset navigation), but most parameter meaning is already clear from schema descriptions. The added value is modest.
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 clearly states the verb "List" and the resource "available 3GPP specifications." It mentions optional filtering by series and ID prefix, plus pagination—fully distinguishing this from sibling tools that list images, OpenAPI specs, or versions.
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 explains optional filtering and pagination, so the agent knows how to use it. However, it does not provide any guidance on when NOT to use this tool vs. alternatives (e.g., search, get_section), missing the opportunity to prevent misuse.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_versionsA
List the versions of a 3GPP specification, newest first.
Each entry reports where the version can be read from:
database: in the prebuilt database, covered by search, images and cross-references
cached: fetched on demand earlier, available immediately
archive: exists upstream; reading it downloads and converts it first, which takes up to a few minutes for a large specification
Pass a version from this list to get_section or get_toc to read a past version.
| Name | Required | Description | Default |
|---|---|---|---|
| spec_id | Yes | required,Specification ID (e.g. TS 23.501) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description effectively discloses behavioral traits: newest-first order, the meaning of three statuses (database, cached, archive), and time cost for archive versions. No contradictions exist.
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 description is well-structured with a clear purpose sentence, bulleted details, and a usage recommendation. It is concise with no redundant information, though slightly more compacting is possible.
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?
Despite having no output schema, the description fully explains the output (list of versions with status meanings) and connects to sibling tools, making the tool's usage context complete.
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 100% and the description adds no meaning beyond the schema's own parameter description ('Specification ID (e.g. TS 23.501)'). Baseline of 3 is appropriate.
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 explicitly states 'List the versions of a 3GPP specification, newest first' – a specific verb and resource that clearly distinguishes from sibling tools like list_specs (list specifications) and list_images (list images).
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 provides explicit context for use: 'Pass a version from this list to get_section or get_toc to read a past version.' This guides when to use the tool, but does not explicitly exclude scenarios where it should not be used.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
searchA
Full-text search across 3GPP specifications using SQLite FTS5 syntax.
Query syntax:
AND/OR/NOT: AMF AND authentication
Phrase: "service based interface"
Prefix: handov*
Column filter: title:authentication or content:handover
Proximity: NEAR(AMF UE, 5)
Hyphenated or dotted terms (e.g. IMS-AKA, sec-agree, 38.101) are auto-quoted to avoid FTS5 syntax errors.
After a positive term, "-term" excludes that term (e.g. AMF -SMF), same as NOT. An exclusion cannot begin a query or immediately follow AND/OR.
Stemming:
The index uses porter stemming: inflected English forms match each other (handover finds handovers).
Prefix and phrase queries operate on stemmed forms, so they can match a bit more broadly than the exact surface text.
Pagination:
Results come as {results, total_count, limit, offset}; total_count is the full match count.
Use limit (default 10, max 200) and offset to page through matches beyond the first page.
Tips:
Use exact 3GPP terms (AMF, SMF, gNB, UE, NRF, PCF, etc.)
Phrase search improves precision for multi-word concepts
title:term restricts matches to section headings only
Use spec_ids to search across multiple specifications at once
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of results per page (default: 10, max: 200) | |
| query | Yes | required,FTS5 query string. Hyphenated or dotted terms like IMS-AKA and 38.101 are auto-quoted. Use AND/OR/NOT operators and double-quoted phrases for exact matches (e.g. '"core network" AND AMF'). | |
| offset | No | Number of results to skip for pagination (default: 0). Combine with total_count in the response to page through all matches. | |
| spec_id | No | Limit search to a single specification (e.g. TS 23.501). Ignored when spec_ids is provided. | |
| spec_ids | No | Limit search to one or more specifications (e.g. ["TS 23.501", "TS 23.502"]). Takes precedence over spec_id. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Given there are no annotations, the description carries full burden for behavioral disclosure. It explicitly states key behaviors: auto-quoting of hyphenated/dotted terms, exclusion syntax, porter stemming, pagination with total_count, and the precedence of spec_ids over spec_id. This is comprehensive beyond what the schema reveals.
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 description is structured with clear sections (Query syntax, Stemming, Pagination, Tips) and is well organized. It earns its length given the complexity of FTS5 syntax, but could be slightly more concise in the exclusion rules section, which repeats some details from the syntax list.
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 covers query syntax, stemming, pagination, and provides domain tips. There is no output schema, but the response structure is described inline (results, total_count, limit, offset). The description is complete for a search tool of this complexity. Minor gap: it does not explain what happens on an empty query or FTS5 syntax errors beyond auto-quoting.
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 100%, so the baseline is 3. The description does add value for some parameters (e.g., explaining spec_ids precedence over spec_id, and specifying default/max for limit), but mostly the query syntax details are an extension of the 'query' parameter's natural behavior rather than new parameter-specific semantics. The description does not add meaning significantly beyond 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 begins with a clear verb and resource: 'Full-text search across 3GPP specifications'. It specifies the technology (SQLite FTS5 syntax), and the query examples clearly differentiate it from sibling tools like search_openapi or list_specs. The purpose is specific and distinct.
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 provides extensive query syntax and tips for effective search (tips on exact terms, phrase search, column filters), but it does not explicitly state when to use this tool versus alternatives like search_openapi or get_section. There is no 'when-not-to-use' guidance. Usage is implied through examples and tips but not formally defined.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
search_openapiA
Full-text search across the OpenAPI definitions of the 5G service-based interface APIs (TS 29.xxx series), using SQLite FTS5 syntax.
Use this when you need an API detail but do not know which API document holds it — searching for a data type (NFProfile, SmContextCreateData) or an endpoint (/nf-instances, subscriptions) finds it without guessing an api_name first. When you already know the document, get_openapi reads it directly.
This is a separate index from the search tool: search covers specification clause text and never returns OpenAPI content, and this tool covers OpenAPI content only.
Results:
One hit is one definition, not one document: either a schema (a data type from components.schemas) or an operation (one HTTP method of one path, named like "PUT /nf-instances/{nfInstanceID}").
A query that is a single bare term ranks a definition of exactly that name first, so searching NFProfile returns the NFProfile schema itself ahead of the schemas that merely reference it.
Each hit reports spec_id, api_name, kind, name and a snippet. Pass those to get_openapi (with its schema or path parameter) to read the full definition.
A schema's text carries one level of $ref expansion, so referenced field names are searchable, but a type two hops away is not. Follow it up with get_openapi.
Set include_body to get the matched definition's full text inline. It is much larger than a snippet.
Query syntax:
AND/OR/NOT: NFProfile AND heartbeat
Phrase: "nf instances"
Prefix: subscri*
Column filter: name:NFProfile or body:nfInstanceId or api_name:Nnrf_NFManagement
Hyphenated, dotted or underscored terms (e.g. nf-instances, 29.510, Nnrf_NFManagement) are auto-quoted to avoid FTS5 syntax errors.
Tokenization:
Unlike search, this index applies no stemming: identifiers are matched as written, and inflected English forms do not fold together.
'-', '.' and '_' split tokens, so Nnrf_NFManagement is indexed as "nnrf" and "nfmanagement" and /nf-instances as "nf" and "instances" — a partial name matches, but camelCase is not split (supportedFeatures is one token).
Pagination:
Results come as {results, total_count, limit, offset}; total_count is the full match count.
Use limit (default 10, max 200) and offset to page through matches beyond the first page.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Limit the search to one kind of definition: "schema" for data types or "operation" for endpoints. Both are searched when omitted. | |
| limit | No | Maximum number of results per page (default: 10, max: 200) | |
| query | Yes | required,FTS5 query string. Hyphenated or dotted terms like nf-instances and 29.510 are auto-quoted. Use AND/OR/NOT operators and double-quoted phrases for exact matches. | |
| offset | No | Number of results to skip for pagination (default: 0). Combine with total_count in the response to page through all matches. | |
| api_name | No | Limit the search to a single API document (e.g. Nnrf_NFManagement). Use list_openapi to see the available names. | |
| spec_ids | No | Limit the search to one or more specifications (e.g. ["TS 29.510", "TS 29.518"]). | |
| include_body | No | Return the full text of each matching definition instead of a snippet (default: false). Costs many more tokens; prefer the default and follow up with get_openapi. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries full burden. It comprehensively discloses behavior: result granularity (one definition per hit), ranking (exact name matches first), $ref expansion depth, include_body effect, query syntax (including auto-quoting for special characters), tokenization rules (no stemming, split on hyphens/dots/underscores, no camelCase split), and pagination details. No contradictory or missing behavioral traits.
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 description is well-structured with sections (Results, Query syntax, Tokenization, Pagination) and front-loaded with the main purpose. While it is long, every sentence provides necessary information given the tool's complexity. It could be slightly more concise, but it earns its length.
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?
Given the complexity (7 parameters, no output schema, multiple sibling tools), the description is complete. It explains the result structure, how to follow up with get_openapi, the difference from search, tokenization idiosyncrasies, and pagination. It addresses all likely agent questions.
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 100%, but the description adds substantial value beyond the schema. It explains the query syntax in detail (operators, phrases, column filters, auto-quoting), the purpose and cost of include_body, how pagination uses limit/offset with total_count, and the meaning of kind (schema vs operation). The description makes the parameters much more usable.
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?
Clearly states the tool performs full-text search on OpenAPI definitions of 5G APIs, using SQLite FTS5 syntax. It distinguishes from sibling tools by explicitly contrasting with 'search' (covers clause text, not OpenAPI) and 'get_openapi' (for when the document is already known).
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 explicit guidance: 'Use this when you need an API detail but do not know which API document holds it.' It also gives a clear alternative: 'When you already know the document, get_openapi reads it directly.' Additionally, it contrasts with the sibling 'search' tool, specifying that search covers different content.
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.
13 tool updates
v0.1.0- First observed
compare_versions - First observed
get_asn1 - First observed
get_image - First observed
get_openapi - First observed
get_references - First observed
get_section - First observed
get_toc - First observed
list_images - First observed
list_openapi - First observed
list_specs - First observed
list_versions - First observed
search - First observed
search_openapi
TDQS
Scored across 13 tools
Every tool targets a distinct content type or operation: listing vs. retrieval, specification text vs. ASN.1 vs. OpenAPI vs. images vs. cross-references. The two search tools explicitly separate specification clauses from OpenAPI definitions, eliminating ambiguity.
All tools use a consistent lowercase snake_case convention with a verb-noun pattern (list_*, get_*, search_*, compare_versions). No mixed conventions or irregular names, making it easy to infer functionality from the name.
13 tools is a well-scoped set for a specification retrieval system. Each tool adds a distinct capability—discovery, reading, searching, comparison, images, ASN.1, OpenAPI, references—without redundancy or bloat.
The tool surface covers the full lifecycle of read-only specification access: discovery (list_specs, list_versions, list_openapi, list_images), retrieval (get_section, get_image, get_asn1, get_openapi), searching (search, search_openapi), comparison (compare_versions), and cross-references (get_references). No obvious gaps for the stated domain.
Maintenance
Related MCP Connectors
Document-to-Markdown MCP server — convert PDF, Office and HTML into LLM-ready Markdown.
Hosted MCP server: convert PDFs to clean, LLM-ready Markdown with tables, formulas and OCR.
3GPP Scout connects Cursor, Claude, Codex and other MCP clients to a hosted, continuously updated 3GPP search service. Search TS/TR specifications across Rel-15 through Rel-20, retrieve cited clauses, and search text, diagrams and figures. Explore recent RAN1, RAN2, RAN3, RAN4 and SA2 TDocs, company proposals and extracted meeting decisions, with source links. Connect using Streamable HTTP at https://api.3gppscout.com/mcp/ and sign in with OAuth 2.1. No local index or API key in the MCP configuration is required. Explorer includes 150 API/MCP requests per month; Founding Engineer includes 1,000 for $8/month. Hosted Scout chat is billed separately. 3GPP Scout is an independent product and is not affiliated with, endorsed or sponsored by 3GPP, ETSI or any 3GPP Organizational Partner. 3GPP™ is a trade mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. Excerpts are quoted for reference and the official documents govern. Copyright, correction or removal requests: contact@3gppscout.com.
Related MCP Servers
- AlicenseAqualityFmaintenanceEnables AI assistants to access and search 3GPP telecommunications specifications through direct integration with the TSpec-LLM dataset. Provides real-time specification content, implementation requirements, and multi-spec comparisons for 3GPP standards development.444 npm29MIT
- AlicenseNot gradedqualityDmaintenanceGeneric MCP server that exposes Markdown documentation to LLMs, enabling them to search and answer questions about any software documentation.MIT
- AlicenseNot gradedqualityDmaintenanceAn MCP server that indexes documents and serves relevant context to LLMs via Retrieval Augmented Generation (RAG).28 npm36MIT
- AlicenseAqualityDmaintenanceA local-first MCP server that ingests PDFs, extracts structure, and provides semantic search and sequential navigation tools for AI clients to query and learn from documents.10MIT