MCP-Typescribe

MCP-Typescribe – ein MCP-Server, der LLMs-API-Informationen bereitstellt

Das Problem

Large Language Models (LLMs) haben enorme Fortschritte bei der Codegenerierung und der Entwicklerproduktivität erzielt. Sie haben jedoch eine wesentliche Einschränkung: Sie können nur APIs und Bibliotheken zuverlässig nutzen, die sie während des Trainings kennengelernt haben. Dies führt zu Engpässen bei der Einführung neuer Tools, SDKs oder interner APIs – LLMs wissen einfach nicht, wie sie diese effektiv nutzen können.

Tools können zwar Zugriff auf den Quellcode (bei der Interaktion mit APIs, deren Quellcode verfügbar ist) oder auf Dokumentationsdateien (z. B. Typescript-Typdefinitionsdateien) erhalten, dies ist jedoch für große APIs nicht gut skalierbar. LLMs benötigen eine effizientere Möglichkeit, mehr über eine API zu erfahren. Die gesamte Dokumentation für jede Anfrage in den Kontext zu stellen, ist ineffizient, nicht praktikabel und führt zu schlechten Ergebnissen.

Infolge:

Größere neue oder interne APIs bleiben für LLMs „unsichtbar“.

Entwickler müssen LLMs manuell anleiten oder Anwendungsbeispiele bereitstellen.

Innovationen werden durch die Verzögerung zwischen der Veröffentlichung einer API und ihrem breiten Verständnis durch KI-Tools gebremst.

Die Idee

Dieses Projekt ist eine Open-Source-Implementierung des Model Context Protocol (MCP) – ein Protokoll, das LLMs kontextbezogenen Echtzeitzugriff auf Informationen ermöglicht. In diesem Fall handelt es sich um die API-Dokumentation und insbesondere um TypeScript-Definitionen.

Unser Ziel ist:

Analysieren Sie TypeScript-Definitionen (und andere) in ein maschinenlesbares Format.

Stellen Sie diesen Kontext LLMs dynamisch über Tools wie Claude, Cline, Cursor oder Windsurf und andere benutzerdefinierte Schnittstellen zur Verfügung.

Ermöglichen Sie agentenbasiertes Verhalten, indem Sie LLMs Abfragen, Planungen und Anpassungen an unbekannte APIs ohne erneute Schulung ermöglichen.

Was dies ermöglicht

Plug-and-Play-API-Unterstützung für LLM-basierte Codierassistenten.

Schnelleres Onboarding für neue oder proprietäre SDKs.

Ein Schritt in Richtung autonomerer, kontextbewusster Codieragenten.

Projektübersicht

Dieses Projekt ermöglicht KI-Agenten, unbekannte TypeScript-APIs effizient zu erkunden und zu verstehen. Es lädt TypeDoc-generierte JSON-Dokumentation und stellt sie über eine Reihe von Abfrageendpunkten bereit. So können Agenten nach Symbolen suchen, detaillierte Informationen zu bestimmten Teilen der API abrufen und die Beziehungen zwischen verschiedenen Komponenten verstehen.

Aktuelle Funktionen

• TypeDoc-Integration : Lädt und indiziert TypeDoc-JSON-Dokumentation für effiziente Abfragen
• Umfassende Abfragefunktionen : Bietet eine breite Palette an Tools zum Erkunden von TypeScript-APIs
• MCP-Protokoll : Befolgt das Model Context Protocol für eine nahtlose Integration mit KI-Agenten

Abfragefunktionen

Der Server stellt die folgenden Tools zum Abfragen der API bereit:

• search_symbols : Suchen Sie Symbole nach Namen mit optionaler Filterung nach Art
• get_symbol_details : Erhalten Sie detaillierte Informationen zu einem bestimmten Symbol
• list_members : Listen Sie Methoden und Eigenschaften einer Klasse oder Schnittstelle auf
• get_parameter_info : Informationen zu Funktionsparametern abrufen
• find_implementations : Findet Implementierungen von Schnittstellen oder Unterklassen
• search_by_return_type : Findet Funktionen, die einen bestimmten Typ zurückgeben
• search_by_description : Suche in JSDoc-Kommentaren
• get_type_hierarchy : Vererbungsbeziehungen anzeigen
• find_usages : Finden Sie heraus, wo ein Typ/eine Funktion verwendet wird

Erste Schritte

Voraussetzungen

• Node.js
• npm

Installation

1. Klonen Sie das Repository
2. Installieren Sie Abhängigkeiten:
   npm install

Verwendung

1. Generieren Sie TypeDoc JSON für Ihre TypeScript-API:
   npx typedoc --json docs/api.json --entryPointStrategy expand path/to/your/typescript/files
   Wenn Sie (nur) eine vorhandene .d.ts Datei haben, können Sie eine API-JSON-Datei wie folgt erstellen:Erstellen Sie eine separate tsconfig.docs.json :
   { "extends": "./tsconfig.json", "files": ["existing.d.ts"], "typedocOptions": { "entryPoints": ["existing.d.ts"], "json": "docs/api.json", "pretty": false } }
   Dann
   npx typedoc --tsconfig tsconfig.docs.json
2. Erstellen Sie das Projekt:
   npm run build
3. Erkunden Sie den MCP-Server:
   npx @modelcontextprotocol/inspector node ./dist/mcp-server/cli.js run-server docs/api.json
4. Verbinden Sie einen KI-Agenten mit dem Server, um die API abzufragenGeben Sie beispielsweise mit cline in VSCode den folgenden MCP-Server in cline_mcp_settings.json an:
   { "mcpServers": { "typescribe": { "command": "npx", "args": [ "-y", "mcp-typescribe@latest", "run-server", "<PATH_TO_API_DOT_JSON>" ], "env": {} } } }
5. Aktivieren Sie den Server und lassen Sie die verschiedenen Tools automatisch genehmigen. Weisen Sie den Agenten an, das Tool „Typescribe“ zu verwenden, um mehr über Ihre API zu erfahren.

Projektstruktur

• src/sample-api/ : Eine TypeScript-Beispiel-API zum Testen – sie verwendet einen seltsamen, deutschähnlichen Dialekt für die API-Namen, um zu testen, dass das LLM die API nicht halluziniert
• src/mcp-server/ : Die MCP-Server-Implementierung
  • utils/ : Hilfsfunktionen
  • schemas/ : JSON-Schemas für die MCP-Tools
  • core/ : Kernfunktionalität
  • server.ts : Die MCP-Serverimplementierung
  • index.ts : Einstiegspunkt für die Bibliotheksexporte
  • cli.ts : der Einstiegspunkt für die CLI/Binärdatei
• tests/ : Tests für die API-Funktionalität

Entwicklung

Ausführen von Tests

Gebäude

Lizenz

MIT

Copyright 2025 yWorks GmbH - https://www.yworks.com