Dokumentation · MCP

Der MCP-Server

Fieldbook bietet einen entfernten Model-Context-Protocol-Server. Ein Agent kann aus seinem Editor die Bibliothek durchsuchen, Komponenten und Versionen abrufen, Installationsbefehle erhalten, Gestaltungshinweise anwenden und Seiten prüfen.

Endpunkt

https://fieldbook.lizardi.mx/api/mcp

Authentifizierung

Jede Anfrage enthält ein Bearer-Token. Zwei Arten werden unterstützt:

  • API-Schlüssel

    Erstelle einen Schlüssel in deiner Übersicht und sende ihn als Authorization: Bearer fb_live_…. Schlüssel werden nur einmal angezeigt; gespeichert wird ausschließlich ihr Hash.

  • Clerk OAuth (falls konfiguriert)

    OAuth-fähige Clients ermitteln den Autorisierungsserver über /.well-known/oauth-protected-resource und authentifizieren sich interaktiv ohne manuell eingegebenen Schlüssel.

Verbinden

Claude Code

claude mcp add --transport http fieldbook https://fieldbook.lizardi.mx/api/mcp --header "Authorization: Bearer <YOUR_KEY>"

Cursor · ~/.cursor/mcp.json

{
  "mcpServers": {
    "fieldbook": {
      "url": "https://fieldbook.lizardi.mx/api/mcp",
      "headers": {
        "Authorization": "Bearer <YOUR_KEY>"
      }
    }
  }
}

ChatGPT-Konnektor. Füge einen benutzerdefinierten Konnektor hinzu, der auf https://fieldbook.lizardi.mx/api/mcp verweist, und füge bei Aufforderung einen API-Schlüssel als Bearer-Token ein.

MCP-Inspektor. Starte den Inspektor, gib den Endpunkt ein und setze einen Authorization: Bearer Header, um die Werkzeuge interaktiv zu erkunden.

MCP Inspector

npx @modelcontextprotocol/inspector

Werkzeuge

Gemessene Werkzeuge verbrauchen Guthaben aus deinem monatlichen Kontingent. Der Eigentümertarif ist ungemessen. Andere Abfragen sind kostenlos und pro Schlüssel begrenzt.

Wähle eine Komponente. Jede Komponente hat eine vierstellige Nummer auf ihrer Karte und Seite. Wähle im Katalog und gib deinem Agenten diese Nummer. Die Komponentenwerkzeuge akzeptieren plate anstelle von slug, und Schreibweisen wie 0412, #412 oder FB-0412 funktionieren ebenfalls. Auf jeder Komponentenseite lassen sich der Bezeichner und eine fertige Anweisung kopieren.

  • search_componentsKostenlos

    query?, category?, framework?, maxSlopScore?, limit (max 25)

    Durchsucht die Bibliothek und liefert Zusammenfassungen mit geprüften Frameworks, Bewertung, Nummer, Anzahl der Steuerelemente und Installationsbefehlen.

  • get_component1 Guthabenpunkt

    slug or plate, framework (default react)

    Ruft den Code für ein Framework ab. React liefert Komponente und Demo, andere Versionen eine Datei. Enthält Steuerelemente, Abhängigkeiten, Bewertungen und Installation.

  • list_frameworksKostenlos

    slug or plate

    Zeigt verfügbare Frameworks und ausstehende Versionen einer Komponente.

  • get_install_commandKostenlos

    slug or plate, framework (default react)

    Installationsbefehl, Registry-URL und ein Ausschnitt für components.json.

  • get_design_guidanceKostenlos

    query?, domain?, stack?, productType?, limit?

    Durchsucht die Sammlung von Gestaltungshinweisen.

  • generate_design_system2 Guthabenpunkte

    productType, keywords?, stack?, variance?, motion?, density?

    Erstellt ein Designsystem mit Palette, Typografie, Layout, Bewegung, UX-Regeln und Prüfungen.

  • get_slop_rulesKostenlos

    category?

    Liefert versionierte Regeln mit Nummer, Titel, Schweregrad, kritischem Fehler und Begründung.

  • get_font_guidanceKostenlos

    role?, family?, name?

    Erklärt Erscheinung und Verhalten empfohlener Schriften, ihre Kombinationen und Auswahlkriterien.

  • suggest_alternativesKostenlos

    ruleId

    Alternativen zu einem Muster und das zugehörige Referenzverzeichnis.

  • score_pageKostenlos

    html? | url?

    Bewertet eine Seite anhand der Regeln; URL-Abrufe verwenden einen SSRF-Schutz.

Registry

Die Bibliothek bietet eine Komponenten-Registry: Installiere eine Komponente direkt oder konfiguriere die Registry in components.json und installiere mit @fieldbook/<name>. Setze FIELDBOOK_TOKEN für Abrufe mit Guthabenverbrauch.

components.json

{
  "registries": {
    "@fieldbook": {
      "url": "https://fieldbook.lizardi.mx/r/react/{name}.json",
      "headers": {
        "Authorization": "Bearer ${FIELDBOOK_TOKEN}"
      }
    }
  }
}

Das maschinenlesbare Verzeichnis der Website und ihrer Endpunkte steht unter /llms.txt.