> ## Documentation Index
> Fetch the complete documentation index at: https://www.zippendo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Tools und Scopes

> Die Tools, die der MCP-Server von Zippendo bietet, welche Berechtigungen sie freischalten, und Beispiel-Prompts.

Die Tools sind die Aktionen, die dein KI-Agent in Zippendo für dich ausführen kann, etwa eine Sendung erstellen oder eine Bestellung lesen. Der MCP-Server bietet ein Tool für jede Aktion der API, und dein Agent sieht nur die Tools, die die [von dir bestätigten Berechtigungen](/docs/de/mcp/authentication) erlauben.

## Wie Tools Berechtigungen zugeordnet sind

Jedes Tool braucht eine Berechtigung (einen Scope), die zu Ressource und Aktion passt:

* Das Lesen von Daten braucht einen Scope `read:`. Das Auflisten von Sendungen braucht zum Beispiel `read:shipments`.
* Das Ändern von Daten braucht den passenden Scope `write:`. Das Erstellen einer Sendung braucht zum Beispiel `write:shipments`.

Scopes bauen aufeinander auf, sodass du weit oder eng vergeben kannst:

* **`write:all`** schließt `read:all` und jeden Scope `write:` in der Tabelle unten ein.
* **`read:all`** schließt jeden Scope `read:` in der Tabelle unten ein.
* **`write:<resource>`** schließt **`read:<resource>`** ein (`write:shipments` schließt `read:shipments` ein).

Ein Agent mit nur `read:shipments` sieht die **Lese**-Tools für Sendungen (Liste, Details, Sendungsverfolgung, Dokumente), aber keines der Tools, die Sendungen erstellen, versenden oder löschen.

## Scope-Referenz

| Ressource | Lese-Scope | Schreib-Scope | Lesen erlaubt dem Agenten… | Schreiben erlaubt zusätzlich… |
| - | - | - | - | - |
| Sendungen | `read:shipments` | `write:shipments` | Sendungen auflisten, Details und Sendungsverfolgung ansehen, Versandetiketten und Dokumente abrufen | Sendungen erstellen, ändern, versenden, aufteilen und löschen; Pakete verschieben; Retourensendungen erstellen; ein Versandetikett erneut abrufen |
| Bestellungen | `read:orders` | `write:orders` | Bestellungen auflisten und ihre Details ansehen | Bestellungen erstellen, ändern und löschen |
| Versanddienstleister | `read:carriers` | `write:carriers` | Verbundene Versanddienstleister und ihre Versandprodukte auflisten | Versanddienstleister verbinden, aktualisieren und entfernen; Paketshops suchen |
| Verkaufskanäle | `read:order_channels` | `write:order_channels` | Verkaufskanäle und den Status ihrer Webhooks auflisten | Kanäle erstellen, ändern und löschen; sie synchronisieren und testen; ihre Webhooks registrieren; Checkout-Token und Signatur-Secrets verwalten |
| Adressen | `read:addresses` | `write:addresses` | Absender-, Abhol- und Retourenadressen auflisten | Adressen erstellen, aktualisieren und löschen |
| Versandregeln | `read:shipping_rules` | `write:shipping_rules` | Versandregeln auflisten | Versandregeln erstellen, ändern und löschen |
| Automatisierungen | `read:automations` | `write:automations` | Automatisierungen, ihre Läufe und die verfügbaren Schritte auflisten | Automatisierungen erstellen, ändern, löschen und ausführen |
| Drucker | `read:printers` | `write:printers` | Drucker auflisten | Drucker registrieren, genehmigen, deaktivieren, ändern und löschen |
| Webhooks | `read:webhooks` | `write:webhooks` | Webhooks und ihre Zustellungen auflisten | Webhooks erstellen, ändern, testen und löschen |
| Integrationen | `read:integrations` | `write:integrations` | Verfügbare Integrationen, deine Verbindungen und deren Zustellungen auflisten | Integrationen verbinden, ändern, testen und löschen |
| Rollen | `read:roles` | `write:roles` | Rollen auflisten | Rollen erstellen, ändern und löschen |
| Teammitglieder | `read:users` | `write:users` | (keine Lese-Tools) | Ein Teammitglied zur Organisation hinzufügen |
| **Alles** | `read:all` | `write:all` | Alle Lese-Tools oben | Alle Tools oben |

Der Zustimmungsbildschirm kann auch weitere Berechtigungen auflisten, etwa zu Organisationen, Teammitgliedern (`org_members`), Retourenportalen und API-Token. Sie schalten heute keine MCP-Tools frei.

<Tip>
  Vergib die engstmögliche Auswahl, mit der die Aufgabe erledigt wird. `read:all` plus `write:shipments` ist ein guter Standard für einen Assistenten, der über alles berichtet, aber nur bei Sendungen handelt.
</Tip>

## Beispiel-Prompts

Sobald die Verbindung steht, sprich in normaler Sprache mit deinem Agenten. Er wählt die passenden Tools und fragt Zippendo:

* "Wie viele Sendungen sind noch ausstehend, und bei welchen Versanddienstleistern?"
* "Erstelle eine Sendung für Bestellung #10421 mit PostNord und nenne mir die Sendungsnummer."
* "Teile die Sendung für Bestellung #10388 in zwei Pakete auf und versende beide."
* "Welche Bestellungen der letzten 24 Stunden haben noch keine Sendung?"
* "Verfolge die Sendung `shp_8f3kd9` und sag mir, ob sie verspätet ist."
* "Füge eine Versandregel hinzu, die Bestellungen über 10 kg mit GLS versendet."

## Tools für Dokumentation und SDKs

Neben den Aktions-Tools lässt der MCP-Server einen Agenten **die Dokumentation von Zippendo lesen**, damit er dir helfen kann, eine Integration in deiner Programmiersprache zu *bauen*. Diese Tools brauchen **keinen Scope**, und jeder verbundene Agent hat sie.

| Tool | Was es bewirkt |
| - | - |
| `search_documentation` | Durchsucht die gesamte Dokumentation: Anleitungen, die vollständige API-Referenz und die SDK-Seiten. Lass die Suchanfrage weg, um den ganzen Index zu durchstöbern. |
| `fetch_documentation` | Liest jede Seite als Markdown (Seiten der API-Referenz enthalten die OpenAPI-Beschreibung des Endpunkts). Übergib `openapi` für die vollständige rohe Spezifikation. |
| `get_sdk_reference` | Die SDK-Referenz für jede Sprache (TypeScript, Python, PHP, Go, Ruby): Methodensignaturen und lauffähige Beispiele. |

Dem Agenten wird gesagt, dass er **das SDK für deine Sprache bevorzugen** und die rohe OpenAPI-Spezifikation nur nutzen soll, wenn es dafür kein SDK gibt. Der Inhalt kommt live von [zippendo.com/docs](https://www.zippendo.com/docs) und aus den SDK-Repositories und ist deshalb immer aktuell.

Probiere Prompts wie diese:

* "Schreibe mit dem Python-SDK von Zippendo ein Skript, das für eine Bestellung eine Sendung erstellt und die Sendungsnummer ausgibt."
* "Wie authentifiziere ich mich in Go bei der Zippendo-API? Zeig mir die Einrichtung des SDK."
* "Ich nutze PHP. Schreibe einen Webhook-Handler, der die Signatur prüft und auf `shipment.dispatched` reagiert."

## Sicherheitsmodell

<CardGroup cols={2}>
  <Card title="Handelt als du" icon="user-check">
    Tool-Aufrufe laufen als du, nur mit den Berechtigungen, die du bestätigt hast.
  </Card>

  <Card title="Eine Organisation" icon="building">
    Eine Verbindung gehört zu einer Organisation. Sie kann die Daten einer anderen Organisation weder lesen noch ändern.
  </Card>

  <Card title="Kein Mitarbeiterzugriff" icon="shield-off">
    Ein Agent kann nie Aktionen des Personals von Zippendo ausführen.
  </Card>

  <Card title="Vollständige Validierung" icon="check-check">
    Jeder Aufruf durchläuft dieselben Prüfungen zu Anmeldung, Tariflimits und Validierung wie die App.
  </Card>
</CardGroup>

Das Löschen von Sendungen, Bestellungen, Versanddienstleistern, Adressen, Versandregeln oder Rollen, das Versenden einer Sendung sowie das Erstellen oder Widerrufen von Checkout-Token und Signatur-Secrets brauchen alle eine ausdrückliche Bestätigung im Tool-Aufruf, der Agent sollte dich also zuerst fragen. Einige sensible Aktionen, etwa die Abrechnung und die Verwaltung von API-Token, sind ganz aus den Tools ausgenommen, und kein Agent kann sie nutzen, egal mit welchen Berechtigungen.

## Dieselben Tools treiben Zippy an

Der MCP-Server teilt seine Tools mit **Zippy**, dem Assistenten in der Zippendo-App. Nur der Ort unterscheidet sich: Zippy läuft in der App, während MCP dein eigenes KI-Tool dieselben Aktionen nutzen lässt. Beide wenden dieselben Berechtigungen, Limits der Organisation und dieselbe Validierung an.

<Card title="Verbinde deinen Agenten" icon="plug" href="/docs/de/mcp/connect" horizontal>
  Bereit zur Einrichtung? Folge der Anleitung für dein Tool.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.