An astronaut overseeing a futuristic data hub
PDF herunterladenMarkdown-Version

Verbinden Sie ReadMe mit ChatGPT, Claude und Gemini

Richten Sie es einmal ein und es funktioniert mit ChatGPT, Claude, Cursor und jedem anderen Client, den Sie lieben. Alles läuft sicher im Hintergrund, damit Sie sich entspannen und sich auf das Wesentliche konzentrieren können. Machen Sie Ihre technische Dokumentation zum Experten für Ihre KI.

Fragen Sie die KI zu diesem Connector

Entwickelt, gewartet und gehostet von Vinkius.

MCP VERIFIZIERT · PRODUKTIONSREIF · VINKIUS GARANTIE

Waiting for input…

Works with modern AI clients that support MCP, including ChatGPT, Claude, Cursor, and more.

ChatGPTClaudeCursorPerplexityGeminiMicrosoft CopilotRaycastMeta AI

Ihre KI erledigt die Arbeit. Wir halten alles sicher und geschützt.

Kein anderes KI-Tool bietet Ihnen das. Ihr Workflow läuft im Client, den Sie bereits lieben, Ihr Konto bleibt geschützt, und Sie entscheiden, was der Agent darf und was nicht. Das ist der ganze Grund für den Wechsel.

Jeder Connector lebt in unserer Infrastruktur, dort wo Ihr Workflow läuft. Die drei Dinge unten sind bereits Teil davon und arbeiten leise im Hintergrund, damit Sie nie darüber nachdenken müssen. Nichts hinzuzufügen, nichts einzurichten, keine Sorgen.

A futuristic MCP client docking bay
V8 Isolate01

Jeder Connector läuft in seiner eigenen abgeschotteten Umgebung.

Jeder Connector läuft in einer eigenen abgeriegelten V8-Laufzeit — kein Zugriff auf Ihre Dateien, Ihr System oder andere Server. Ein Connector sieht nie über seine eigene Anfrage hinaus.

Kill-Switch02

Ein Schalter stoppt jeden Agenten. Sofort.

Eine einzige Aktion deaktiviert jeden Connector, entzieht jedes Token und beendet jede Sitzung auf einmal. Die AI Governance bewahrt das Protokoll.

FinOps pro Nutzer03

Ausgabelimits, die anhalten, statt Sie zu überraschen.

Jeder Nutzer behält eigene Verbindungen und Anmeldedaten, isoliert von allen anderen. Was Ihr Ausgabelimit überschreiten würde, wird zurückgehalten und wartet auf Ihre Freigabe, anstatt abgerechnet zu werden.

Drei Kontrollen, eingebaut in die Schicht, über die sich Ihre KI verbindet.

Kuratiertes Set · 10 Fähigkeiten

Wir liefern nur die Aktionen, die zählen.

Fähigkeiten-Set01 / 03

01-04

4 Fähigkeiten in diesem Set.

Teil von 10, verfügbar über ReadMe.

  1. 01

    Dokumentations-Kategorien auflisten

    Zeigt alle verfügbaren Dokumentationskategorien auf ReadMe an.

  2. 02

    Kategorie-Details abrufen

    Ruft detaillierte Informationen zu einer spezifischen Dokumentationskategorie ab.

  3. 03

    Eigene Seiten auflisten

    Listet alle benutzerdefinierten, eigenständigen Seiten auf.

  4. 04

    Dokumentationsseite lesen

    Ruft den vollständigen Inhalt einer bestimmten Dokumentationsseite ab.

Fähigkeiten-Set02 / 03

05-07

3 Fähigkeiten in diesem Set.

Teil von 10, verfügbar über ReadMe.

  1. 05

    Seiten einer Kategorie auflisten

    Zeigt alle Dokumentationsseiten an, die einer bestimmten Kategorie zugeordnet sind.

  2. 06

    Changelog-Eintrag lesen

    Ruft den vollständigen Inhalt eines spezifischen Changelog-Beitrags ab.

  3. 07

    Dokumentation durchsuchen

    Führt eine Volltextsuche über alle veröffentlichten Dokumentationsseiten durch.

Fähigkeiten-Set03 / 03

08-10

3 Fähigkeiten in diesem Set.

Teil von 10, verfügbar über ReadMe.

  1. 08

    Changelogs auflisten

    Zeigt eine Liste aller verfügbaren Changelog-Beiträge an.

  2. 09

    Eigene Seite abrufen

    Ruft den vollständigen Inhalt einer benutzerdefinierten Seite ab.

  3. 10

    Projektdetails abrufen

    Ruft Informationen über das gesamte ReadMe-Projekt ab.

Echte Arbeit

Was Teams täglich ausführen

01

API Implementation

An engineer asks the AI to write a function based on the exact parameters found in the ReadMe API reference.

02

Documentation Audits

A writer uses the AI to find every mention of a deprecated endpoint across all pages.

03

Onboarding Support

A developer asks the AI to summarize the 'Getting Started' guide to understand the initial setup.

04

Product Update Sync

A team uses the AI to summarize recent changelogs to stay updated on new feature releases.

Eine Aufgabe automatisieren

Bringen Sie ReadMe für eine Sache an die Arbeit.

Schritt-für-Schritt-Automatisierungen, die Ihre KI über diesen Connector ausführt: der Ablauf, die Prompts für den Einstieg und die genauen Fähigkeiten hinter jedem Schritt.

Ein Connector, jede KI

ReadMe funktioniert mit den beliebtesten KI-Clients.

Dies sind die beliebtesten Clients, jeder mit einer Schritt-für-Schritt-Anleitung: ein Link, einmal eingerichtet, mit Governance und Sichtbarkeit an Bord. Und da alles auf dem MCP-Standard läuft, funktioniert dieselbe Verbindung auch in jedem anderen kompatiblen Client — nichts neu zu bauen.

ClaudeClaudeChatGPTChatGPTGeminiGeminiPerplexityPerplexityGrokGrokMicrosoft CopilotMicrosoft CopilotCursorCursorVS CodeVS CodeWindsurfWindsurfJetBrainsJetBrainsClineClineLangChainLangChainVercel AI SDKVercel AI SDKLovableLovableZ.aiZ.aiRaycastRaycastQwen CodeQwen CodeKimi CodeKimi CodeLe ChatLe Chat

Bauen Sie Ihre eigene App? Der Connector gehört Ihnen.

Sie brauchen keinen Client, um ReadMe arbeiten zu lassen: dieselbe gehostete Verbindung speist Ihre eigenen Anwendungen und Ihren Agenten-Code, mit derselben Governance bei jeder Anfrage. Damit bauen, damit chatten — eine Verbindung für beides.

Beobachtet, nicht geschätzt

Durchschnitt 853ms. Schnell in der Produktion.

ReadMe wird täglich gegen den Live-Service geprüft.

TagesdurchschnittSpitze 1110ms
3. Okt.Heute
Schnellster Tag
676ms
Langsamster Tag
1110ms
14-Tage-Trend
Verlangsamend+5%

Verbinden Sie Ihren Client

Eine URL. Jeder Client.

Aktivieren Sie den Connector, kopieren Sie Ihren Link und fügen Sie ihn in den Client ein, den Sie bereits nutzen. 10 Fähigkeiten kommen einsatzbereit an.

Vorschauzugang · keine Anbieter-Authentifizierung

Das vk_preview_*-Token gehört zur Vorschau-Infrastruktur von Vinkius. Es ermöglicht Claude, die Fähigkeiten von ReadMe zu entdecken und anzuzeigen, damit Sie das Erlebnis in Ihrer KI sehen.

Es authentifiziert Ihr Konto nicht bei ReadMe. Aktionen, die Anmeldedaten oder echte Kontodaten erfordern, werden möglicherweise erst ausgeführt, wenn Sie den Connector aktivieren und den Dienst autorisieren.

ReadMe Connector

Alles bereit. Wählen Sie Ihren MCP-Client und folgen Sie den Einrichtungsschritten.

Connector-Linkhttps://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp

Claude Desktop

Folgen Sie den Schritten unten, um sich in Sekunden zu verbinden.

  1. 1In Claude Desktop, open Settings → Connectors.
  2. 2Click “Add custom connector” and paste the connector link above as the remote MCP server URL.
  3. 3Click Add and start a new chat — ReadMe capabilities are ready to use.
Konfiguration · claude_desktop_config.jsonKopieren
{
  "mcpServers": {
    "readme-mcp": {
      "url": "https://edge.vinkius.com/vk_preview_65dP2ZEWi1ggQrtmq1IKVpZ6MOAhFxi6q98C5XwC/mcp"
    }
  }
}
  • Claude
  • ChatGPT
  • Cursor
  • VS Code
  • Windsurf
  • Claude Code
  • JetBrains
  • Cline

Schritt-für-Schritt-Anleitungen für jeden Client finden Sie im Guide. Verbinden

Geführte Einrichtung für Claude? ReadMe in Claude und anderen KI-Tools einrichten

Alle KI-Clients ansehen, mit denen dieser Connector funktioniert ↑

Für wen

Für die Arbeit, die ReadMe-Nutzer abgeben.

Dieser MCP-Connector richtet sich an Fachkräfte, die technische Dokumentationen effizient nutzen und verwalten müssen.

  • 01

    Developer Advocates

    Überprüfen die Genauigkeit veröffentlichter Guides und erstellen Entwürfe basierend auf bestehenden Strukturen.

  • 02

    Technical Writers

    Durchsuchen und prüfen die aktuelle Dokumentation auf veraltete Referenzen, ohne den Editor verlassen zu müssen.

  • 03

    Software Engineers

    Rufen die offizielle API-Dokumentation direkt in ihre IDE, um sicherzustellen, dass der Code den Standards entspricht.

FAQ

Fragen von ReadMe-Nutzern.

  • 01

    How do I connect my ReadMe docs to my AI?

    You connect the MCP via Vinkius and provide your ReadMe API Key, which you can find in your project's Configuration settings.

  • 02

    Which AI clients can use this MCP?

    This MCP works with any compatible client, including Claude, Cursor, Windsurf, and VS Code.

  • 03

    Can the AI see my private documentation?

    The AI can access any documentation that your provided ReadMe API Key has permission to view.

  • 04

    Does this work with API references?

    Yes, the AI can search and retrieve full content from your API reference pages.

  • 05

    Can I use this to check for recent updates?

    Yes, the MCP includes capabilities to list and retrieve the full content of your changelog posts.

  • 06

    Where do I obtain my ReadMe API Key?

    Log into your ReadMe dashboard. Navigate to your specific project, then open 'Configuration' and click on 'API Key'. You will use this key as the authentication parameter (our integration handles it natively as a Basic Auth username).

  • 07

    Does the server allow me to write or edit documentation?

    Currently, the MCP server is focused on read-only operations. It can query, retrieve, and search changelogs, custom pages, and standard documentation categories, bringing context to the AI securely without risking accidental overwrites.

  • 08

    In what format is the document content returned?

    All text and page content uses native Markdown format directly fetched from ReadMe's engine. This makes it perfect for the AI to interpret, syntax-highlight, and display naturally within chat or code comments.

Entdecken

Mehr in Developer Tools

Vorschläge

Verbinde ReadMe mit Claude, Cursor, ChatGPT & mehr