MCP-Server

Jede Jamdesk-Website enthält einen integrierten MCP-Server (Model Context Protocol). Während llms.txt KI-Tools eine statische Momentaufnahme Ihrer Dokumentation bereitstellt, können sie mit MCP interaktiv suchen und Abfragen ausführen – nützlich, wenn KI-Agenten bestimmte Antworten finden müssen, anstatt alles zu lesen.

Was ist MCP?

Das Model Context Protocol ist ein offener Standard, der KI-Tools den Zugriff auf externe Datenquellen ermöglicht. Ihre Jamdesk-Dokumentation stellt über MCP zwei Tools bereit:

Tool	Zweck
`searchDocs`	Dokumentation nach Schlüsselwörtern durchsuchen und sortierte Ergebnisse zurückgeben
`getPage`	Den vollständigen Inhalt einer bestimmten Seite abrufen

Ihre Endpoint-URL

Ihr MCP-Endpoint ist Ihre Dokumentations-URL mit angehängtem /_mcp. Wenn Sie eine benutzerdefinierte Domain aktiviert haben, verwenden Sie diese:

Einrichtung	Endpoint
Benutzerdefinierte Domain unter `docs.acme.com`	`https://docs.acme.com/_mcp`
Keine benutzerdefinierte Domain	`https://my-project.jamdesk.app/_mcp`

Verwenden Sie bevorzugt den Endpoint der benutzerdefinierten Domain, sobald eine solche verbunden ist – dadurch bleibt Ihr Branding in jeder URL erhalten, die KI-Tools sehen, und der Endpoint funktioniert auch weiterhin, wenn Sie Ihre .jamdesk.app-Subdomain später mit Nur benutzerdefinierte Domain ausblenden.

Schnelle Einrichtung

Fügen Sie Ihre Dokumentation als MCP-Server hinzu:

claude mcp add --transport http my-docs https://docs.acme.com/_mcp

Ersetzen Sie docs.acme.com durch Ihre Dokumentationsdomain – oder durch my-project.jamdesk.app, wenn Sie keine benutzerdefinierte Domain verbunden haben.

Wenn Sie Claude nun zu Ihrem Projekt befragen, kann Claude Ihre Dokumentation direkt durchsuchen und lesen.

Verfügbare Tools

searchDocs

Durchsuchen Sie Ihre Dokumentation und erhalten Sie sortierte Ergebnisse.

Parameter:

Parameter	Typ	Erforderlich	Beschreibung
`query`	string	Ja	Suchbegriffe (z. B. „authentication“, „getting started“)
`limit`	number	Nein	Maximale Anzahl an Ergebnissen (Standard: 10, maximal: 50)
`type`	string	Nein	Nach Inhaltstyp filtern: `all`, `api`, `guide`, `quickstart`, `help`, `component`

Beispielanfrage:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "searchDocs",
    "arguments": {
      "query": "authentication",
      "limit": 5
    }
  }
}

Beispielantwort:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [{
      "type": "text",
      "text": "{\"query\":\"authentication\",\"total\":1,\"results\":[{\"title\":\"Authentication\",\"description\":\"How to authenticate API requests\",\"url\":\"/docs/api/authentication\",\"type\":\"api\",\"score\":0.95}]}"
    }]
  }
}

getPage

Rufen Sie den vollständigen Inhalt einer bestimmten Dokumentationsseite ab.

Parameter:

Parameter	Typ	Erforderlich	Beschreibung
`slug`	string	Ja	Seitenpfad ohne das Präfix `/docs` (z. B. `api/authentication`)

Beispielanfrage:

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "getPage",
    "arguments": {
      "slug": "api/authentication"
    }
  }
}

Beispielantwort:

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "content": [{
      "type": "text",
      "text": "{\"title\":\"Authentication\",\"description\":\"How to authenticate\",\"content\":\"## Overview\\n\\nUse API keys to authenticate...\",\"url\":\"/docs/api/authentication\"}"
    }]
  }
}

Den Endpoint testen

Sie können Ihren MCP-Endpoint direkt mit curl testen:

# List available tools
curl -X POST https://docs.acme.com/_mcp \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}'

# Search for content
curl -X POST https://docs.acme.com/_mcp \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"searchDocs","arguments":{"query":"getting started"}}}'

Funktionsweise

Der MCP-Endpoint verwendet einen Suchindex, der zusammen mit Ihrer Dokumentation erstellt wird:

BM25-Ranking – Sortiert Ergebnisse nach Relevanz
Fuzzy Matching – Behandelt Tippfehler (Toleranz von 1 Zeichen)
Field Boosting – Titel und Abschnittsüberschriften werden höher gewichtet als Inhalte im Fließtext
Typfilterung – Filtert Ergebnisse nach Inhaltstyp (API, Anleitung usw.)

Der Index wird bei jedem Bereitstellen neu erstellt.

Ratenbegrenzungen

Der MCP-Endpoint ist auf 60 Anfragen pro Minute und IP-Adresse begrenzt. Dies ist für die normale Nutzung durch KI-Assistenten ausreichend. Wenn Sie das Limit überschreiten, erhalten Sie eine 429-Antwort.

Fehlerbehebung

Überprüfen Sie, ob Ihre Endpoint-URL korrekt und erreichbar ist:

curl https://docs.acme.com/_mcp

Sie sollten eine JSON-Antwort mit Serverinformationen sehen. Falls nicht, prüfen Sie, ob Ihre Dokumentation mindestens einmal erstellt wurde.

Der Suchindex wird beim Build erstellt. Wenn Sie kürzlich Inhalte hinzugefügt haben, lösen Sie über Ihr Jamdesk-Dashboard einen erneuten Build aus, um den Index zu aktualisieren.

Stellen Sie sicher, dass der Slug exakt mit Ihrem Seitenpfad übereinstimmt (ohne die Erweiterung .mdx). Wenn sich Ihre Seite beispielsweise unter api/authentication.mdx befindet, verwenden Sie api/authentication als Slug.

Wie geht es weiter?

Mit KI schreiben

Tipps zur Nutzung von KI-Tools zum Schreiben von Dokumentation

llms.txt

Automatisch generierter Seitenindex für KI-Tools