Invantive-Dokumentation
Invantive SupportforenAnmelden / Eintragen

Werkzeuge

Invantive MCP Server bietet einem KI-Client wie Anthropic Claude folgende Tools an. Die Tools auf einer Datenbank lesen nur: Sie ändern keine Daten und führen kein SQL-Statement aus. Nur check_sql nimmt eines entgegen; es wird geparst, aber nicht ausgeführt. Die Status-Tools arbeiten auf einer Statusseite von Invantive Cloud Status statt auf einer Datenbank; vier davon ändern die Statusseite.

  • describe_entities: listet die Entitäten auf, die aus der Datenbank gelesen werden können, mit ihrem Namen, Label, Typ, Datencontainer und der Größenordnung ihrer Zeilenanzahl. Verfügbar ab Version 26.0. Siehe unten.
  • describe_entity: beschreibt eine Entität vollständig, mit ihren Feldern, Primärschlüssel, eindeutigen Schlüsseln, Fremdschlüsseln und der zu erwartenden Geschwindigkeit. Verfügbar ab Version 27.0. Siehe unten.
  • read_records: liest Zeilen aus einer Entität, mit Select, Filter, Sortierung und Anzahl der Zeilen in der Notation der Abfrageschnittstelle von OData Version 4. Verfügbar ab Version 26.0. Siehe unten.
  • analyze_records: führt dasselbe Lesen wie read_records aus und gibt zurück, wie es ausgeführt wurde, statt der Zeilen. Verfügbar ab Version 28.0. Siehe unten.
  • current_cloud_user: gibt das Profil des angemeldeten Benutzers und der Organisation dieses Benutzers zurück, so wie sie in Invantive Cloud gespeichert sind. Verfügbar ab Version 26.0. Siehe unten.
  • check_sql: prüft die Syntax von Invantive UniversalSQL- und PSQL-Statements, ohne sie auszuführen. Verfügbar ab Version 28.0. Siehe unten.
  • status_get_summary: gibt den Zustand der Statusseite auf einen Blick zurück. Siehe unten.
  • status_list_incidents: listet die Vorfälle der Statusseite auf, die neuesten zuerst. Siehe unten.
  • status_get_incident: gibt einen Vorfall mit seinen Komponenten und Aktualisierungen zurück. Siehe unten.
  • status_create_incident: eröffnet einen Vorfall auf der Statusseite. Siehe unten.
  • status_add_update: veröffentlicht eine Aktualisierung zu einem Vorfall, mit der er aufgelöst werden kann. Siehe unten.
  • status_set_component_state: setzt den Zustand einer Komponente. Siehe unten.
  • status_schedule_maintenance: plant eine Wartung mit einem Zeitfenster. Siehe unten.

Anweisungen an den Client

Wenn sich ein KI-Client verbindet, sendet der Server ihm Anweisungen. Sie nennen die Version des Servers und die Adressen, unter denen dieselbe Datenbank für andere Clients verfügbar ist, mit der Angabe, ob der Benutzer jede Adresse aktiviert hat: Invantive MCP Server, das SQL-Server-Protokoll von Invantive UniversalSQL Server für SQL-Server-Clients und ODBC, Bridge Online für Power BI und App Online für Anwendungen, beide über OData Version 4. Sie geben außerdem Hinweise zum effizienten Lesen, nennen die Ratenbegrenzungen der Plattformen und verweisen auf Invantive Data Hub.

Die Anweisungen besagen außerdem, dass Invantive Cloud Daten zwischen der Datenbank und anderen Plattformen austauschen kann, indem sie repliziert, kombiniert oder integriert werden. Sie listen die kommerziellen Namen dieser Plattformen auf, etwa Exact Online, Salesforce und AFAS Profit. Die Liste enthält die Plattformen, für die Invantive Cloud einen Treiber hat. Testtreiber, Hilfsprogramme, veraltete Treiber und die eigenen Produkte von Invantive sind ausgenommen. Die Liste ist ab Release 27.0 verfügbar.

Auflisten von Entitäten

describe_entities listet die Entitäten der Datenbank auf, die gelesen werden können, damit ein KI-Client eine davon auswählen kann. Es beschreibt eine Entität nicht vollständig: Dafür ist describe_entity zuständig, und zwar für eine einzelne Entität. Das Tool nimmt zwei Argumente entgegen, beide optional:

  • entities: die Namen der aufzulistenden Entitäten. Ein Name wird ohne Berücksichtigung der Groß- und Kleinschreibung abgeglichen und muss so geschrieben sein, wie eine frühere Antwort ihn zurückgegeben hat. Ein einzelner Name oder eine durch Kommas getrennte Liste wird anstelle eines Arrays akzeptiert.
  • nameOnly: wenn true, wird jede Entität auf ihren Namen, ihr Label, ihren Typ und ihren Datencontainer reduziert. Verwenden Sie es nur, wenn die Antwort gekürzt wurde. Standardmäßig ist false.

Die Antwort enthält:

  • database: das URL-Segment der Datenbank.
  • detailLevel: summary, oder namesOnly, wenn nameOnly angewendet wurde.
  • entityCount und returnedEntityCount: die Anzahl der Entitäten, die der Anfrage entsprechen, und die Anzahl der Entitäten in der Antwort.
  • truncated und truncationHint: vorhanden, wenn die Antwort weniger Entitäten enthält, als zutreffen. Der Hinweis erklärt, wie man eine engere Frage stellt, indem man die gewünschten Entitäten in entities nennt.
  • unknownEntities und unknownEntitiesHint: vorhanden, wenn entities einen Namen enthält, der nicht existiert. Der Hinweis nennt die nächstliegenden existierenden Entitäten für höchstens die ersten fünf unbekannten Namen. unknownEntitiesHint ist ab Release 27.0 verfügbar.
  • dataContainers: ein Objekt pro Datencontainer, da Partitionierung zum Datencontainer und nicht zur Entität gehört. Er enthält den alias, den ein Entitätsname nach dem @ trägt, den provider, der den Datencontainer bereitstellt, und ob er supportsPartitions unterstützt. Ein Datencontainer, der Partitionen unterstützt, enthält außerdem partitionLabelPlural, partitionCount, selectedPartitionCount und allPartitionsSelected: den Begriff, den die Plattform für mehrere Partitionen verwendet, etwa Divisionen in Exact Online, die Anzahl der verfügbaren Partitionen, die Anzahl, die ein Aufruf von read_records abfragt, und ob dies alle sind.
  • partitioningNote: wie sich die Partitionierung zu den Entitäten dieser Datenbank verhält. Vorhanden, wenn mindestens ein Datencontainer Partitionen unterstützt.
  • selectedPartitionCountTotal: die Anzahl der ausgewählten Partitionen über alle Datencontainer hinweg.
  • entities: ein Objekt pro Entität, sortiert nach Datencontainer und dann nach Name, damit eine gekürzte Antwort bei jedem Aufruf dieselben Entitäten auslässt.

Eine Entität enthält:

  • name: der Name, der im Argument entity von read_records und describe_entity übergeben wird.
  • label: die Bezeichnung, die die Plattform für den Inhalt verwendet. Nur vorhanden, wenn sie von name abweicht.
  • type: die Art des Objekts, etwa table, view oder tablefunction.
  • dataContainer: der Alias des Datencontainers, der die Entität enthält.
  • rowCountBand: die Größenordnung der Zeilenanzahl, sofern die Plattform eine Schätzung liefert. Der Wert ist empty, <=100, <=1k, <=10k, <=100k, <=1M oder >1M.
  • notReadable: true, wenn die Entität nicht gelesen werden kann. Sonst nicht vorhanden.

Die Elemente rowCountBand und notReadable entfallen, wenn nameOnly angewendet wird.

Bis einschließlich Release 26.0 enthielt jede Entität außerdem description, keyField und partitionSpecific, und ein Datencontainer enthielt die gesamte Partitionierung: die Begriffe, die Partitionsspalte und die ausgewählten Partitionen. Ab Release 27.0 stehen diese in der Antwort von describe_entity. Dadurch bleibt die Liste kurz und schnell bei einer Datenbank mit über tausend Entitäten.

Die Größe der Antwort ist standardmäßig auf 60,000 Zeichen begrenzt. Die Einstellung MaxDescribeEntitiesResponseChars ändert diese Grenze. Sie ist ab Release 26.0 verfügbar. Die Einstellung MaxEntityDescriptionChars wird ab Release 27.0 nicht mehr verwendet, da die Liste keine Beschreibungen enthält.

Die folgenden Argumente listen zwei Entitäten der Datenbank auf:

{ "entities": [ "SalesInvoices", "Accounts" ] }

Beschreiben einer Entität

describe_entity beschreibt eine Entität vollständig. Ein KI-Client ruft es mit einem Namen aus describe_entities auf, bevor er die Entität mit read_records liest. Sie ist ab Release 27.0 verfügbar. Das Tool nimmt ein Argument entgegen:

  • entity: der Name der Entität, so wie describe_entities ihn zurückgibt. Ein Name wird ohne Berücksichtigung der Groß- und Kleinschreibung abgeglichen. Erforderlich.

Ein nicht vorhandener Name wird mit dem Meldungscode itgenmcp665 abgewiesen. Der Hinweis nennt die nächstliegenden vorhandenen Entitäten.

Die Antwort enthält:

  • database: das URL-Segment der Datenbank.
  • name, label, labelSingular, type und dataContainer: wie in der Liste. label und labelSingular sind nur vorhanden, wenn sie von name abweichen.
  • description: was die Entität enthält, für einen Geschäftsanwender und vollständig beschrieben. documentation ist eine weitere Erläuterung, sofern die Plattform eine liefert.
  • partitionSpecific: true, wenn der Inhalt von den ausgewählten Partitionen abhängt. Sonst nicht vorhanden.
  • notReadable: true, wenn die Entität nicht gelesen werden kann. Sonst nicht vorhanden.
  • rowCountBand und estimatedRowCount: die Größenordnung der Zeilenanzahl und die Schätzung selbst, sofern die Plattform eine liefert. Eine Schätzung ist keine Zählung.
  • performance: was man bei der Lesegeschwindigkeit der Entität erwarten kann.
  • primaryKey, uniqueKeys und foreignKeys: die Schlüssel und die Beziehungen zu anderen Entitäten.
  • dataContainerDetails und partitioningNote: der Datencontainer, der die Entität enthält, und wie sich die Partitionierung auf die Entität bezieht.
  • fieldCount, returnedFieldCount, truncated und truncationHint: die Anzahl der Felder, die Anzahl in der Antwort und, wenn Felder weggelassen werden, was dagegen zu tun ist.
  • fields: die Felder der Entität.

Ein Feld enthält:

  • name: der Name, so wie die Argumente select, filter und orderby von read_records ihn akzeptieren.
  • label: die Bezeichnung, die die Plattform verwendet. Nur vorhanden, wenn sie von name abweicht.
  • dataType: der primitive Typ von OData-Version 4, etwa String, Int32, Decimal, DateTimeOffset, Boolean oder Guid.
  • nullable: ob das Feld leer sein kann.
  • maxLength, precision und scale: die Länge eines Text- oder Binärfelds und die Stellen eines Dezimalfelds, sofern die Plattform sie angibt.
  • primaryKey: true, wenn das Feld Teil des Primärschlüssels ist. Sonst nicht vorhanden.
  • description: was das Feld enthält, für einen Geschäftsanwender beschrieben.
  • filterOnPlatform: true, wenn die Plattform selbst einen Filter auf das Feld auswertet, sodass nur die passenden Zeilen abgerufen werden. False, wenn zuerst jede Zeile abgerufen und danach gefiltert wird, was bei einer großen Entität langsam ist.
  • sortOnPlatform: true, wenn die Plattform selbst nach dem Feld sortiert. Nicht vorhanden, wenn das nicht bekannt ist.

Die Elemente uniqueKeys und foreignKeys sowie die guarantee eines Schlüssels sind ab Release 28.0 verfügbar. Die Version 27.0 liefert den Primärschlüssel ohne Garantie, da ihre Engine keine weiteren Schlüsselmetadaten vorhält.

Ein Schlüssel enthält fields, guarantee und, sofern die Plattform ihn angibt, name. Die Garantie ist enforced, wenn die Plattform selbst den Schlüssel eindeutig hält, und declared, wenn der Treiber oder das Modell sie angibt, ohne dass die Plattform sie erzwingt. Die Felder eines Schlüssels werden wie die Felder der Entität benannt. Ein Name, der kein Feld der Entität ist, wird so geschrieben, wie die Plattform die Spalte benennt. Ein Schlüssel, der den Primärschlüssel wiederholt, wird nicht in uniqueKeys aufgeführt.

Ein Fremdschlüssel ist eine Beziehung von Feldern dieser Entität zum Schlüssel einer anderen Entität. Er enthält:

  • fields: die Felder dieser Entität, die den Bezug enthalten.
  • referencedEntity und referencedFields: die referenzierte Entität, so wie describe_entities sie benennt, und ihre Felder in derselben Reihenfolge wie fields.
  • referencedTable: der Name, den die Plattform dem referenzierten Objekt gibt. Nur vorhanden, wenn dieses Objekt keine Entität dieser Datenbank ist; in diesem Fall enthält referencedFields die Spaltennamen der Plattform.
  • kind: key, wenn die Felder auf einen Schlüssel der referenzierten Entität verweisen, textual, wenn die Beziehung nur sprachlich besteht und unter einer Bedingung gilt, und candidate, wenn sie sich aus den Feldnamen ergibt und in den Daten gilt, ohne dass die Plattform sie angibt.
  • guarantee: enforced oder declared, wie bei einem Schlüssel.
  • description: legt fest, wann eine textual- oder candidate-Beziehung gilt. Eine Beziehung dieser Arten gilt nicht für jede Zeile.
  • name: der Name des Fremdschlüssels auf der Plattform, sofern vorhanden.

Dieser Server liest pro Aufruf eine Entität und führt keine Joins aus. Ein KI-Client liest die zugehörigen Zeilen mit einem zweiten Aufruf von read_records, indem er nach den Werten von fields filtert.

Die Performance enthält die folgenden Angaben, sofern der Treiber der Plattform sie angibt:

  • accessLatencyMs: die durchschnittliche Zeit eines Hin- und Rückwegs zur Plattform in Millisekunden.
  • fullScanRowsPerMinute: die durchschnittliche Anzahl Zeilen pro Minute, wenn die gesamte Entität gelesen wird.
  • pointQueryRowsPerMinute: die durchschnittliche Anzahl Zeilen pro Minute, wenn Zeilen über einen Filter auf einen Schlüssel gelesen werden.
  • estimatedFullScanSeconds: eine Schätzung der Zeit zum Lesen aller Zeilen der Entität, aus estimatedRowCount und fullScanRowsPerMinute. Sie ist nur vorhanden, wenn beide Werte bekannt sind.

Die Werte sind statische Durchschnittswerte des Treibers für die Plattform und keine Messungen dieser Datenbank. Der Wert für Schreibvorgänge wird nicht zurückgegeben, da der Server nur liest. Ein Treiber, der keine Werte angibt, lässt performance weg.

Die Größe der Antwort ist standardmäßig auf 60,000 Zeichen begrenzt. Die Einstellung MaxDescribeEntityResponseChars ändert diese Grenze, und MaxSelectedPartitionsDescribed die Anzahl der in dataContainerDetails aufgeführten Partitionen. Beides ist ab Version 27.0 beziehungsweise 26.0 verfügbar. Passen die Felder nicht hinein, stehen die Felder der Schlüssel zuerst. Die Schlüssel, die Beziehungen und die Performance werden nie weggelassen.

Die folgenden Argumente beschreiben eine Entität der Datenbank:

{ "entity": "SalesInvoices" }

Datensätze lesen

read_records liest Zeilen aus einer Entität. Ein KI-Client ruft es einmal auf, nachdem describe_entities gezeigt hat, welche Entität die Daten enthält, und describe_entity ihre Felder aufgelistet hat. Das Werkzeug nimmt folgende Argumente entgegen:

  • entity: der Name der Entität, so wie describe_entities ihn zurückgibt. Erforderlich.
  • select: eine durch Kommas getrennte Liste von Feldnamen, so wie describe_entity sie zurückgibt, in der $select-Notation der Abfrageschnittstelle von OData Version 4.
  • filter: die Bedingung, der die Zeilen entsprechen müssen, in der $filter-Notation, mit den Operatoren eq, ne, gt, ge, lt, le, and, or und not.
  • orderby: eine Liste von Feldern mit Sortierrichtung, in der $orderby-Notation, etwa AmountDC desc.
  • first: die maximale Anzahl der zu lesenden Zeilen. Wird sie weggelassen, werden alle Zeilen gelesen, die dem Filter entsprechen.

Der Lesevorgang wird in ein select-Statement übersetzt und unter der Berechtigung des angemeldeten Benutzers ausgeführt. Die Zeilen werden als strukturierter Inhalt zurückgegeben, ein Objekt pro Zeile mit den ausgewählten Feldern. Es gibt keinen Cursor und keine Seitenaufteilung. Ein KI-Client übergibt first, sofern er nicht die gesamte Menge möchte, und schränkt die Antwort mit filter und orderby ein.

Ein Feld oder Literal, das der OData-Parser nicht kennt, wird mit dem Meldungscode itgenmcp640 abgelehnt. Betrifft die Ablehnung ein Feld, nennt der Hinweis die Felder der Entität, die am ehesten passen. Datums- und Zahlenwerte werden ohne Anführungszeichen geschrieben.

Die folgenden Argumente lesen die fünf größten offenen Rechnungen einer Entität:

{ "entity": "SalesInvoices"
, "select": "InvoiceNumber,AmountDC"
, "filter": "Status eq 20"
, "orderby": [ "AmountDC desc" ]
, "first": 5
}

Analyse eines Lesevorgangs

analyze_records nimmt die Argumente von read_records entgegen: entity, das erforderlich ist, sowie select, filter, orderby und first. Der Lesevorgang wird in dasselbe select-Statement übersetzt, unter derselben Berechtigung ausgeführt und auf dieselbe Weise protokolliert. Seine Zeilen werden gelesen und gezählt, aber nicht zurückgegeben. Die Antwort enthält:

  • sqlStatement: das ausgeführte select-Statement.
  • rowsReturned und rowsRead: die Zeilen, die das Statement zurückgegeben hat, und die Zeilen, die es aus allen Tabellen gelesen hat.
  • counters: was das Statement gezählt hat, über alle Schritte summiert, etwa PairsEvaluated oder RowsSorted; nur die Zähler, die nicht null sind.
  • steps: ein Objekt pro Schritt der Ausführung, etwa das Lesen einer Tabelle, ein Join oder ein Sortieren, mit denselben Eigenschaften wie eine Zeile der Datei /steps von Invantive Data Hub: die Art und Beschreibung des Schritts, die Zeilen ein und aus, die Dauer, Prozessorzeit und Speicherzuweisung einschließlich der folgenden Schritte, dieselben Werte ohne die folgenden Schritte, wie explain analyze sie misst, wie ein Join seine Zeilen zugeordnet hat, die Anzahl der Zeilen, die eine Tabelle deklariert, und die Zähler des Schritts selbst. Die Eigenschaften eines Schritts werden wie auf dieser Zeile geschrieben, beginnend mit einem Großbuchstaben, etwa ExclusiveCpuMs.

Ein KI-Client ruft es auf, wenn ein Lesevorgang langsam ist oder mehr Zeilen liest, als er zurückgibt, etwa um zu sehen, ob ein Filter an den Datencontainer übergeben wurde, welcher Join-Algorithmus gewählt wurde oder welcher Schritt den Speicher zugewiesen hat. Die Messung jedes Schritts kostet eine Ablesung der Prozessorzeit pro Zeile und pro Schritt, was nur dieses Tool verursacht.

Die folgenden Argumente analysieren den Lesevorgang der fünf größten offenen Rechnungen einer Entität mit denselben Argumenten, die read_records verwenden würde:

{ "entity": "SalesInvoices"
, "select": "InvoiceNumber,AmountDC"
, "filter": "Status eq 20"
, "orderby": [ "AmountDC desc" ]
, "first": 5
}

Den aktuellen Benutzer lesen

current_cloud_user gibt das Profil des angemeldeten Benutzers und der Organisation dieses Benutzers zurück, so wie es in Invantive Cloud gespeichert ist. Ein KI-Client ruft es auf, wenn die Antwort davon abhängt, wer fragt oder zu welcher Organisation die Daten gehören. Das Tool nimmt keine Argumente entgegen und liest nichts aus der Datenbank.

Die Antwort enthält folgende Eigenschaften des Benutzers:

  • Uid, Iwid und CognitoUserId: die Kennungen des Benutzers, des Web-Benutzers und beim Identity Provider.
  • Name, GivenName und FamilyName: der vollständige Name, der Vorname und der Nachname.
  • Gender: M für männlich, F für weiblich und U für unbekannt.
  • JobTitle: die Berufsbezeichnung.
  • EmailAddress, PhoneNumber und MobileNumber: wie der Benutzer erreichbar ist.
  • LanguageCode: die Sprache im Format ISO 639-1. Die Standardsprache des Dienstes wird verwendet, wenn der Benutzer keine hat.
  • CreatedUtc und ModifiedUtc: wann der Benutzer angelegt und zuletzt geändert wurde.
  • LogInStartUtc und LogInEndUtc: der Zeitraum, in dem sich der Benutzer anmelden kann.
  • UserIconUrl und UserIcon: das Miniaturbild des Benutzers als Adresse und in binärer Form.

Die Antwort enthält folgende Eigenschaften der Organisation des Benutzers:

  • PartyName: der Name der Organisation. Der Name im Profil des Benutzers wird zuerst verwendet, und der Name der Organisation selbst, wenn das Profil keinen hat. Die Ausweichlösung ist ab Release 27.0 verfügbar.
  • PartyAddressLine1, PartyAddressLine2, PartyAddressLine3, PartyPostalCode, PartyCity und PartyCountry: die Adresse. Das Land der Organisation wird zuerst verwendet, und das Land im Profil des Benutzers, wenn die Organisation keines hat. Die Ausweichlösung ist ab Release 27.0 verfügbar.
  • PartyEmailAddress, PartyPhone und PartyWebSite: wie die Organisation erreichbar ist.
  • PartyLegalStructure: die Rechtsform, etwa NL-BV.
  • PartyCoCNumber, PartyVatNumber, PartyIban und PartyBic: die Handelsregisternummer, die USt-IdNr., die IBAN und die BIC.

Die Eigenschaften PartyCurrencyCode, PartyState, PartyGlnNumber, PartyRsinNumber, PartySiretNumber, PartyPaypalIdentifier und PartyWageTaxNumber sind Teil der Antwort, aber der Dienst füllt sie nicht. Invantive Cloud enthält keinen Wert dafür.

Die Syntax von SQL prüfen

check_sql analysiert eine oder mehrere Invantive-UniversalSQL- und PSQL-Statements, getrennt durch ;, ohne sie auszuführen und ohne die Datenbank zu lesen. Ein KI-Client ruft es für ein Statement auf, das er für Invantive Data Hub, Invantive Query Tool oder ein Skript geschrieben hat, bevor das Statement ein Budget kostet oder Daten ändert. Namen von Tabellen und Spalten werden nicht geprüft, da dafür die Datenbank nötig ist. Verfügbar ab Version 28.0.

Das Tool nimmt ein Argument entgegen, sql, mit höchstens 1,000,000 Zeichen. Die Antwort enthält:

  • Valid: true, wenn die Statements der Grammatik folgen.
  • MessageCode, Message und Hint: der Syntaxfehler, seine Meldung mit Auszug und Markierungen sowie was zu tun ist. Die Codes werden in Syntax Errors erklärt.
  • Url: die Adresse des Abschnitts des Meldungscodes in Syntax Errors.
  • Position: Line und Column, gezählt ab 1 mit einem Tabulator als eine Spalte, Offset, gezählt ab 0 im Text, und Length, die Anzahl der markierten Zeichen.
  • Syntax: Kind wie missing oder premature-end, Expected mit dem, was an dieser Position gültig ist, als Liste nicht übersetzter Elemente wie FROM, ,, name oder expression, und Context mit dem Teil des Statements wie whereClause.

Ein Syntaxfehler ist die Antwort des Tools und kein Fehler des Tools: das Ergebnis wird nicht als Fehler markiert.

Tools zum Status von Invantive Cloud

Die Statuswerkzeuge ermöglichen es einem KI-Client, eine Statusseite von Invantive Cloud Status zu lesen und zu pflegen, zum Beispiel um zu beantworten, ob ein Dienst ausgefallen ist, oder um eine Störung zu melden. Sie werden nur auf einem Server angeboten, auf dem die Einstellungen StatusPage:Server und StatusPage:ApiToken gesetzt sind: die Adresse des Statusservers, zum Beispiel https://statuspage.invantive.eu, und ein API-Token eines Mandanten, das unter "Einstellungen" und "API-Tokens" erstellt wird. StatusPage:TimeoutSec legt die Anzahl Sekunden fest, die ein Aufruf dauern darf; der Standardwert ist 20. Die Werkzeuge sind noch nicht freigegeben.

Die Werkzeuge arbeiten auf den Seiten des Mandanten des Tokens. Ein Token mit dem Umfang read genügt für die drei Werkzeuge, die lesen. Die vier Werkzeuge, die die Statusseite ändern, benötigen ein Token mit dem Umfang write; mit einem Token des Umfangs read lehnt der Statusserver sie ab. Eine Änderung ist für Leser sofort sichtbar und kann Abonnenten benachrichtigen. Deshalb wird der KI-Client angewiesen, den Text vor dem Aufruf mit dem Benutzer zu bestätigen.

Die Zustände einer Komponente sind operational, degraded_performance, partial_outage, major_outage und under_maintenance. Die Phasen eines Vorfalls sind investigating, identified, monitoring und resolved.

status_get_summary nimmt keine Argumente entgegen. Die Antwort enthält:

  • overallState: der schwerwiegendste Zustand über die Komponenten, die für den Gesamtzustand zählen.
  • componentCount: die Anzahl der Komponenten.
  • componentsNotOperational: pro Komponente, die nicht operational ist, ihr Code component, name, state sowie der Zeitpunkt since, seit dem sie diesen Zustand hat.
  • openIncidents: pro Vorfall, der nicht gelöst ist, dessen publicId, title, phase, impact und startedAt.
  • maintenance: die Wartung, die gerade läuft oder innerhalb von sieben Tagen geplant ist, mit publicId, title, phase, windowStart und windowEnd.

status_list_incidents nimmt zwei optionale Argumente entgegen:

  • openOnly: bei true nur Vorfälle, die nicht gelöst sind. Standardmäßig ist false.
  • first: die Anzahl der neuesten Vorfälle, die zurückgegeben werden, von 1 bis 100. Standardwert ist 20.

Die Antwort enthält incidents mit denselben Angaben pro Vorfall wie openIncidents von status_get_summary.

status_get_incident nimmt die publicId eines Vorfalls entgegen, zum Beispiel 2026-0187. Die Antwort ist der Vorfall so, wie ihn die Verwaltungs-API des Statusservers zurückgibt, mit seinen betroffenen Komponenten und deren Zustand, seinem Verlauf von Aktualisierungen mit deren Phase und seiner Version.

status_create_incident nimmt entgegen:

  • title: den Titel, den die Leser sehen. Erforderlich.
  • message: die erste Aktualisierung, für Kunden.
  • impact: eine von none, minor, major oder critical. Standardwert ist minor.
  • phase: die Phase der ersten Aktualisierung. Standardwert ist investigating.
  • template: der Code einer Vorfall-Schablone, die alles ergänzt, was nicht angegeben ist.
  • components: die betroffenen Komponenten, jede mit ihrem Code component und dem state, den sie erhält, solange der Vorfall offen ist.

status_add_update nimmt entgegen:

  • publicId: die öffentliche ID des Vorfalls. Erforderlich.
  • message: der Text der Aktualisierung, für Kunden. Erforderlich.
  • phase: die Phase der Aktualisierung. Erforderlich. Die Phase resolved schließt den Vorfall und setzt seine Komponenten wieder auf operational.
  • internalNote: eine Notiz nur für Betreiber, die niemals veröffentlicht oder gesendet wird.

status_set_component_state nimmt entgegen:

  • component: der Code der Komponente, so wie status_get_summary ihn zurückgibt. Erforderlich.
  • state: der neue Zustand. Erforderlich.
  • hold: bei true ändern die Prüfungen den Zustand nicht, bis ein Betreiber ihn freigibt. Standard ist true.

status_schedule_maintenance nimmt entgegen:

  • title: den Titel, den die Leser sehen. Erforderlich.
  • message: was geschieht und was die Leser bemerken. Erforderlich.
  • windowStart und windowEnd: Beginn und Ende des Zeitfensters als ISO 8601-Datum und -Uhrzeit mit Offset, zum Beispiel 2026-11-08T06:00:00+01:00. Erforderlich.
  • components: die Codes der betroffenen Komponenten.
  • autoStart: die Wartung zu Beginn des Zeitfensters starten. Standard ist true.
  • autoComplete: die Wartung am Ende des Zeitfensters abschließen. Standard ist true.
  • muteProbes: die Prüfungen der betroffenen Komponenten während des Zeitfensters stummschalten. Standard ist true.

Die Werkzeuge, die die Statusseite ändern, geben den Vorfall, die Komponente oder die Wartung so zurück, wie der Statusserver sie nach der Änderung liefert.

Verfolgung der Größe einer Antwort

Invantive MCP Server schreibt die Größe jeder Antwort in Zeichen in den Pfad. Die Größe ist die Menge der Pfadzeile mit der Nachrichtencode itgenmcp664, die auf der Debug-Stufe geschrieben wird. Sie summiert den strukturierten Inhalt und die Textblöcke der Antwort, und die Nachricht nennt das Werkzeug, die Datenbank und beide Teile. Die Zeile wird sowohl für eine erfolgreiche als auch für eine fehlgeschlagene Antwort geschrieben, da der KI-Client beide in seinem Kontext liest. Der Envelope der JSON-RPC-Nachricht wird nicht mitgezählt. Verfügbar ab Version 27.0.

Wenn ein Tool fehlschlägt

Ein Tool, das fehlschlägt, antwortet mit isError auf true gesetzt und den Details im strukturierten Inhalt, damit der KI-Client dem Benutzer mitteilen kann, was zu tun ist. Die Antwort enthält:

  • Message und MessageCode: was schiefgegangen ist und der Code, den man bei einer Hilfeanfrage angibt.
  • KindRequest: der Hinweis, also der nächste Schritt für den KI-Client oder den Benutzer. Jede Antwort enthält einen. Ist kein konkreter Hinweis bekannt, wird angegeben, ob die Anfrage erneut gesendet, korrigiert oder dem Benutzer mitgeteilt werden soll.
  • NaturalKey: worum es in der Meldung geht, etwa die Datenbank oder die angeforderte Entität.
  • IsRecoverable: true, wenn das erneute Senden derselben Anfrage später erfolgreich sein kann, und false, wenn nicht. Es wird weggelassen, wenn nichts auf eines von beiden hindeutet.
  • RetryAfterSec: die Anzahl Sekunden, die der Dienst zum Warten empfohlen hat, bevor dieselbe Anfrage erneut gesendet wird, aus einer Sperre oder aus dem Header Retry-After der Plattform. Er ist nur vorhanden, wenn IsRecoverable true ist und eine Wartezeit empfohlen wurde; es wird keine Wartezeit erfunden. Ist die Wartezeit länger als 60 Sekunden, weist der Hinweis den KI-Client an, die Wartezeit dem Benutzer zu überlassen. Verfügbar ab Version 27.0.
  • Actor: wer zuerst handeln muss. ai, wenn der KI-Client die Anfrage korrigieren oder warten und erneut senden kann, user, wenn eine Person außerhalb des Gesprächs entscheiden oder handeln muss, etwa bei einer Lizenz, einer IP-Adresse oder einer Anmeldung, und forums, wenn niemand das Problem im Gespräch lösen kann, sodass das Geschäftszeichen und der Meldungscode im Forum nachgeschlagen oder gemeldet werden. Eine Wartezeit von mehr als 60 Sekunden ist für den Benutzer bestimmt. Verfügbar ab Version 27.0.
  • HelpUrl: die Adresse des Forenbeitrags oder der Hilfeseite zum Meldungscode, sofern bekannt. Verfügbar ab Version 27.0.
  • Uid: das Geschäftszeichen / der Bezug des Fehlers, den man beim Support angibt.

Eine Anfrage nach einer Entität oder einem Feld, die bzw. das nicht existiert, nennt im Hinweis die nächstliegenden vorhandenen Namen. describe_entities tut dasselbe für die Namen im Argument entities, in unknownEntitiesHint. Beides ist ab Version 27.0 verfügbar.

Eine Anfrage von einer IP-Adresse, die für die Datenbank nicht autorisiert ist, wird mit dem Meldungscode itgenmcp326 abgelehnt. Die Meldung nennt die Adresse, und der Hinweis nennt die Datenbank, zu der sie hinzugefügt werden muss.

Ein Statustool, das fehlschlägt, antwortet auf die gleiche Weise. Verweigert der Statusserver den Aufruf, enthält MessageCode den Meldungscode des Statusservers, oder itgenmst001, wenn die Antwort keinen enthält. Eine Ablehnung wegen fehlendem Scope write bittet den Benutzer, ein Token mit Scope write anzufordern. itgenmst002 bedeutet, dass die Statustools auf dem Server nicht konfiguriert sind, und itgenmst003, dass der Statusserver nicht erreichbar ist.

Anmerkungen zu dieser Version