Zum Hauptinhalt springen
Alle Tools arbeiten mit dem einen Shop, den Sie genehmigt haben. Eine Theme-ID eines anderen Shops liefert not_found. Schreib-Tools (save_draft, propose_edit) werden nur aufgeführt, wenn die Verbindung den Scope themes:write hat. Ergebnisse sind JSON, eingeschlossen in einen Block für nicht vertrauenswürdige Daten. Fehlschläge sind Tool-Fehler mit einem code: invalid_input, not_found, forbidden, conflict, limit, busy, unsupported oder internal.

Typischer Ablauf

  1. get_reference (Thema overview, dann zum Beispiel commerce oder app_blocks mit der Theme-Art), um zu erfahren, was die Plattform unterstützt.
  2. list_themes, um die Kopie zu finden, dann list_files, read_file oder search.
  3. save_draft mit baseHash aus Ihrem Lesevorgang.
  4. validate für die Datei und scan für ein hochgeladenes Design.
  5. preview_link und den Link an den Nutzer weitergeben. Der Nutzer veröffentlicht im Panel.

Lese-Tools

get_reference

Die Plattformreferenz, generiert aus derselben Registry, die der Editor und validate verwenden. Keine Shop-Daten. Liefert kompaktes JSON. Zum Beispiel liefert { "topic": "app_blocks", "name": "buy_now" } seine Argumente mit Typen, Pflicht-Flags und Aliasen, sein Verhalten und seine Unterstützung pro Theme-Art.

Ressourcen

Dieselbe Referenz ist als MCP-Ressourcen verfügbar (resources/list, resources/read, resources/templates/list):

list_themes

Die Theme-Kopien des Shops: Liquid Themes, hochgeladene Designs und Theme-Code-Pakete, mit id, name, kind, live und updatedAt. Keine Argumente.

list_files

Liefert files (path, size, kind, contentHash), höchstens 400, und truncated.

read_file

Liefert content, contentHash, startLine, endLine und totalLines. Binäre Medien liefern binary: true ohne Inhalt.

read_files

Liefert files mit jeweils content und contentHash, insgesamt höchstens 1 MB. Fehlende Dateien haben missing: true; Dateien jenseits des Größenbudgets haben skipped. Liefert Treffer mit path, line, column und einer Zeilenvorschau.

get_schema

Ohne path: die Theme-Einstellungen aus config/settings_schema.json und jede Section mit ihrem Namen, ihren Einstellungs-IDs und Blocktypen. Mit path: das vollständige {% schema %}-JSON der Section. Beide Antworten enthalten sectionObject: die Section-Felder und den Hinweis zu section.css_id.

validate

Ohne path und proposalId wird die gesamte Kopie so validiert, wie es beim Veröffentlichen geschieht. Liefert valid und problems (path, line, column, message, severity). Bei Theme-Code-Paketen ist eine unveränderte section.id in CSS oder id=/for= eine warning (setzt valid nie auf false). Markiert außerdem unbekannte App-Blöcke, unbekannte oder falsch typisierte Argumente (mit einem Meinten-Sie-Vorschlag), Blöcke, die die Theme-Art nicht unterstützt, unbekannte PapelShip-Aufrufe und SDK-Aufrufe, die dort nie ausgeführt werden (zum Beispiel Inline-Skripte auf Liquid-Theme-Seiten).

scan

Testlauf des Sicherheitsscanners für Designs. Es wird nichts gespeichert. Liquid Themes liefern unsupported. Liefert url, einen Link zur Vorschau im PapelShip Panel. Der Nutzer muss angemeldet sein. Sie zeigt die gespeicherten Dateien (Entwürfe) der Kopie. Testen Sie Klicks, Umschalter und Links auf dieser Seite; die Arbeitsfläche des visuellen Editors wählt beim Klicken aus.

Schreib-Tools

save_draft

Erfordert themes:write. Übergeben Sie genau eines von content oder edits. Speichervorgänge werden wie Speichervorgänge im Editor validiert; eine ungültige Datei liefert invalid_input mit dem ersten Problem. Jedes Ergebnis enthält problems aus der Editor-Diagnose, zum Beispiel die Warnung zu section.css_id in Code-Paketen.

propose_edit

Erfordert themes:write. Dieselben Argumente wie save_draft plus eine erforderliche einzeilige summary; note wird nicht verwendet. Speichert nie: Der Vorschlag wartet darauf, dass der Inhaber ihn im Code-Editor annimmt, und läuft nach 24 Stunden ab. Verwenden Sie es, wenn der Inhaber jede Änderung prüfen soll.

Protokoll

  • Transport: Streamable HTTP, JSON-Antworten, keine Sitzungen. GET liefert 405.
  • Protokollversionen: 2025-11-25, 2025-06-18, 2025-03-26, 2024-11-05.
  • Batches: bis zu 10 Nachrichten. Jede Nachricht zählt zum Rate Limit.
  • Autorisierung: OAuth 2.1 mit PKCE, ermittelt über https://app.papelship.com/.well-known/oauth-protected-resource/mcp, oder ein Themes-API-Schlüssel als Bearer-Token.