documentatie van Invantive
Invantive Support ForumsAanmelden / Inschrijven

Extra

Invantive MCP Server biedt de volgende hulpmiddelen aan een AI-client zoals Anthropic Claude. De hulpmiddelen op een database lezen alleen: ze wijzigen geen gegevens en voeren geen SQL-instructie uit. Alleen check_sql accepteert er één, die het parseert zonder het uit te voeren. De statustools werken op een statuspagina van Invantive Cloud Status in plaats van op een database; vier ervan wijzigen de statuspagina.

  • describe_entities: somt de entiteiten op die uit de database gelezen kunnen worden, met hun naam, label, type, datacontainer en de orde van grootte van hun aantal rijen. Beschikbaar vanaf release 26.0. Zie hieronder.
  • describe_entity: beschrijft één entiteit volledig, met de velden, primaire sleutel, unieke sleutels, vreemde sleutels en de verwachte snelheid. Beschikbaar vanaf release 27.0. Zie hieronder.
  • read_records: leest rijen uit één entiteit, met select, filter, sortering en aantal rijen in de notatie van de query-interface van OData-versie 4. Beschikbaar vanaf release 26.0. Zie hieronder.
  • analyze_records: voert dezelfde lezing uit als read_records en geeft terug hoe deze is uitgevoerd in plaats van de rijen. Beschikbaar vanaf release 28.0. Zie hieronder.
  • current_cloud_user: geeft het profiel terug van de ingelogde gebruiker en van de organisatie van die gebruiker, zoals opgeslagen in Invantive Cloud. Beschikbaar vanaf release 26.0. Zie hieronder.
  • check_sql: controleert de syntaxis van Invantive UniversalSQL- en PSQL-statements zonder ze uit te voeren. Beschikbaar vanaf release 28.0. Zie hieronder.
  • status_get_summary: geeft in één oogopslag de status van de statuspagina weer. Zie hieronder.
  • status_list_incidents: somt de incidenten van de statuspagina op, nieuwste eerst. Zie hieronder.
  • status_get_incident: geeft één incident terug met de bijbehorende componenten en updates. Zie hieronder.
  • status_create_incident: opent een incident op de statuspagina. Zie hieronder.
  • status_add_update: plaatst een update bij een incident, waarmee het kan worden opgelost. Zie hieronder.
  • status_set_component_state: stelt de status van één component in. Zie hieronder.
  • status_schedule_maintenance: plant onderhoud met een tijdvenster. Zie hieronder.

Instructies voor de client

Wanneer een AI-client verbinding maakt, stuurt de server die instructies naar de client. Ze noemen de versie van de server en de adressen waarop dezelfde database beschikbaar is voor andere clients, met de vermelding of de gebruiker elk adres heeft geactiveerd: Invantive MCP Server, het SQL Server-protocol van Invantive UniversalSQL Server voor SQL Server-clients en ODBC, Bridge Online voor Power BI en App Online voor applicaties, beide via OData-versie 4. Ze geven ook advies over efficiënt lezen, noemen de snelheidslimieten van de platforms en verwijzen naar Invantive Data Hub.

De instructies vermelden ook dat Invantive Cloud gegevens kan uitwisselen tussen de database en andere platforms, door ze te repliceren, te combineren of te integreren. Zij noemen de commerciële namen van die platforms, zoals Exact Online, Salesforce en AFAS Profit. De lijst bevat de platforms waarvoor Invantive Cloud een driver heeft. Testdrivers, hulpprogramma's, verouderde drivers en de eigen producten van Invantive zijn uitgesloten. De lijst is beschikbaar vanaf release 27.0.

Entiteiten weergeven

describe_entities geeft de entiteiten van de database weer die gelezen kunnen worden, zodat een AI-client er een kan kiezen. Het beschrijft geen entiteit volledig: describe_entity doet dat voor één entiteit. De tool neemt twee argumenten, beide optioneel:

  • entities: de namen van de op te sommen entiteiten. Een naam wordt gematcht zonder hoofdlettergevoeligheid en moet worden geschreven zoals een eerder antwoord die teruggaf. Een enkele naam of een kommagescheiden lijst wordt geaccepteerd in plaats van een array.
  • nameOnly: wanneer waar, wordt elke entiteit teruggebracht tot naam, label, type en datacontainer. Gebruik het alleen wanneer het antwoord is afgekapt. Standaard is false.

Het antwoord bevat:

  • database: het URL-segment van de database.
  • detailLevel: summary, of namesOnly wanneer nameOnly is toegepast.
  • entityCount en returnedEntityCount: het aantal entiteiten dat aan het verzoek voldoet en het aantal entiteiten in het antwoord.
  • truncated en truncationHint: aanwezig wanneer het antwoord minder entiteiten bevat dan er overeenkomen. De hint legt uit hoe je een specifiekere vraag stelt door de gewenste entiteiten te noemen in entities.
  • unknownEntities en unknownEntitiesHint: aanwezig wanneer entities een naam bevat die niet bestaat. De hint noemt de dichtstbijzijnde bestaande entiteiten voor maximaal de eerste vijf onbekende namen. unknownEntitiesHint is beschikbaar vanaf release 27.0.
  • dataContainers: één object per datacontainer, omdat de partitionering bij de datacontainer hoort en niet bij de entiteit. Het bevat de alias die een entiteitsnaam na de @ draagt, de provider die de datacontainer bedient, en of deze supportsPartitions. Een datacontainer die partities ondersteunt, bevat ook partitionLabelPlural, partitionCount, selectedPartitionCount en allPartitionsSelected: de term die het platform gebruikt voor meerdere partities, zoals divisies bij Exact Online, het aantal beschikbare partities, het aantal dat een aanroep van read_records opvraagt, en of dat alle partities zijn.
  • partitioningNote: hoe partitionering zich verhoudt tot de entiteiten van deze database. Aanwezig wanneer minstens één datacontainer partities ondersteunt.
  • selectedPartitionCountTotal: het aantal geselecteerde partities over alle datacontainers.
  • entities: één object per entiteit, geordend op datacontainer en daarna op naam, zodat een afgekapt antwoord bij elke aanroep dezelfde entiteiten weglaat.

Een entiteit bevat:

  • name: de naam die je doorgeeft in het argument entity van read_records en describe_entity.
  • label: het label dat het platform gebruikt voor de inhoud. Alleen aanwezig wanneer het afwijkt van name.
  • type: het soort object, zoals table, view of tablefunction.
  • dataContainer: de alias van de datacontainer die de entiteit bevat.
  • rowCountBand: de orde van grootte van het aantal rijen, wanneer het platform een schatting geeft. De waarde is empty, <=100, <=1k, <=10k, <=100k, <=1M of >1M.
  • notReadable: true wanneer de entiteit niet gelezen kan worden. Anders afwezig.

De leden rowCountBand en notReadable worden weggelaten wanneer nameOnly is toegepast.

Tot en met release 26.0 bevatte elke entiteit ook description, keyField en partitionSpecific, en een datacontainer bevatte de volledige partitionering: de termen, de partitiekolom en de geselecteerde partities. Vanaf release 27.0 staan deze in het antwoord van describe_entity. Dat houdt de lijst kort en snel op een database met meer dan duizend entiteiten.

De grootte van het antwoord is standaard beperkt tot 60,000 tekens. De instelling MaxDescribeEntitiesResponseChars wijzigt die limiet. Het is beschikbaar vanaf release 26.0. De instelling MaxEntityDescriptionChars wordt niet meer gebruikt vanaf release 27.0, omdat de lijst geen beschrijvingen bevat.

De volgende argumenten geven twee entiteiten van de database aan:

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

Een entiteit beschrijven

describe_entity beschrijft één entiteit volledig. Een AI-client roept het aan met een naam uit describe_entities, voordat het de entiteit leest met read_records. Het is beschikbaar vanaf release 27.0. De tool heeft één argument:

  • entity: de naam van de entiteit, zoals describe_entities deze teruggeeft. Een naam wordt vergeleken zonder onderscheid te maken tussen hoofd- en kleine letters. Verplicht.

Een naam die niet bestaat wordt geweigerd met foutcode itgenmcp665. De hint noemt de dichtstbijzijnde bestaande entiteiten.

Het antwoord bevat:

  • database: het URL-segment van de database.
  • name, label, labelSingular, type en dataContainer: zoals in de lijst. label en labelSingular zijn alleen aanwezig wanneer zij verschillen van name.
  • description: wat de entiteit bevat, geschreven voor de zakelijke gebruiker en volledig uitgeschreven. documentation is een nadere toelichting, wanneer het platform die geeft.
  • partitionSpecific: true wanneer de inhoud afhangt van de geselecteerde partities. Anders afwezig.
  • notReadable: true wanneer de entiteit niet gelezen kan worden. Anders afwezig.
  • rowCountBand en estimatedRowCount: de orde van grootte van het aantal rijen en de schatting zelf, wanneer het platform die levert. Een schatting is geen telling.
  • performance: wat u kunt verwachten van de snelheid waarmee de entiteit wordt gelezen.
  • primaryKey, uniqueKeys en foreignKeys: de sleutels en de relaties met andere entiteiten.
  • dataContainerDetails en partitioningNote: de datacontainer die de entiteit bevat en hoe de partitionering zich verhoudt tot de entiteit.
  • fieldCount, returnedFieldCount, truncated en truncationHint: het aantal velden, het aantal in het antwoord en, wanneer velden worden weggelaten, wat daaraan te doen is.
  • fields: de velden van de entiteit.

Een veld bevat:

  • name: de naam zoals de argumenten select, filter en orderby van read_records deze accepteren.
  • label: het label dat het platform gebruikt. Alleen aanwezig wanneer het afwijkt van name.
  • dataType: het primitieve type van OData-versie 4, zoals String, Int32, Decimal, DateTimeOffset, Boolean of Guid.
  • nullable: of het veld leeg mag zijn.
  • maxLength, precision en scale: de lengte van een tekst- of binair veld en de cijfers van een decimaal veld, wanneer het platform deze vermeldt.
  • primaryKey: true wanneer het veld deel uitmaakt van de primaire sleutel. Anders afwezig.
  • description: wat het veld bevat, geschreven voor de zakelijke gebruiker.
  • filterOnPlatform: waar wanneer het platform zelf een filter op het veld evalueert, zodat alleen de overeenkomende rijen worden opgehaald. Onwaar wanneer eerst alle rijen worden opgehaald en daarna gefilterd, wat traag is bij een grote entiteit.
  • sortOnPlatform: waar wanneer het platform zelf op het veld sorteert. Afwezig wanneer dat niet bekend is.

De leden uniqueKeys en foreignKeys, en de guarantee van een sleutel, zijn beschikbaar vanaf release 28.0. Release 27.0 geeft het antwoord voor de primaire sleutel zonder garantie, omdat de engine geen andere sleutelmetadata bevat.

Een sleutel bevat fields, guarantee en, wanneer het platform die geeft, name. De garantie is enforced wanneer het platform zelf de sleutel uniek houdt, en declared wanneer het stuurprogramma of het model dit vastlegt zonder dat het platform het afdwingt. De velden van een sleutel worden benoemd zoals de velden van de entiteit. Een naam die geen veld van de entiteit is, wordt geschreven zoals het platform de kolom noemt. Een sleutel die de primaire sleutel herhaalt, wordt niet vermeld in uniqueKeys.

Een vreemde sleutel is een relatie van velden van deze entiteit naar de sleutel van een andere entiteit. Deze bevat:

  • fields: de velden van deze entiteit die de verwijzing bevatten.
  • referencedEntity en referencedFields: de entiteit waarnaar wordt verwezen, zoals describe_entities haar noemt, en haar velden, in dezelfde volgorde als in fields.
  • referencedTable: de naam die het platform geeft aan het object waarnaar wordt verwezen. Alleen aanwezig wanneer dat object geen entiteit van deze database is; in dat geval bevat referencedFields de kolomnamen van het platform.
  • kind: key wanneer de velden verwijzen naar een sleutel van de verwezen entiteit, textual wanneer de relatie alleen in woorden bestaat en onder een voorwaarde geldt, en candidate wanneer zij volgt uit de namen van de velden en in de gegevens geldt zonder dat het platform dit vermeldt.
  • guarantee: enforced of declared, zoals bij een sleutel.
  • description: geeft aan wanneer een textual- of candidate-relatie geldt. Een relatie van deze soorten geldt niet voor elke rij.
  • name: de naam van de vreemde sleutel op het platform, wanneer het platform er een heeft.

Deze server leest één entiteit per aanroep en voegt niets samen. Een AI-client leest de verwante rijen met een tweede aanroep van read_records, waarbij gefilterd wordt op de waarden van fields.

De prestaties bevatten de volgende leden, wanneer de driver van het platform die vermeldt:

  • accessLatencyMs: de gemiddelde tijd van één heen-en-weer verkeer met het platform in milliseconden.
  • fullScanRowsPerMinute: het gemiddelde aantal rijen per minuut wanneer de hele entiteit wordt gelezen.
  • pointQueryRowsPerMinute: het gemiddelde aantal rijen per minuut wanneer rijen worden gelezen via een filter op een sleutel.
  • estimatedFullScanSeconds: een schatting van de tijd om elke rij van de entiteit te lezen, op basis van estimatedRowCount en fullScanRowsPerMinute. Deze is alleen aanwezig wanneer beide bekend zijn.

De cijfers zijn statische gemiddelden van de driver voor het platform en geen metingen van deze database. Het cijfer voor schrijven wordt niet teruggegeven, omdat de server alleen leest. Een driver die geen cijfers vermeldt, laat performance weg.

De grootte van het antwoord is standaard beperkt tot 60,000 tekens. De instelling MaxDescribeEntityResponseChars wijzigt die limiet en MaxSelectedPartitionsDescribed het aantal partities dat vermeld wordt in dataContainerDetails. Beide zijn beschikbaar vanaf release 27.0 respectievelijk 26.0. Wanneer de velden niet passen, komen de velden van de sleutels eerst. De sleutels, de relaties en de prestaties worden nooit weggelaten.

De volgende argumenten beschrijven één entiteit van de database:

{ "entity": "SalesInvoices" }

Rijen lezen

read_records leest rijen uit één entiteit. Een AI-client roept deze eenmaal aan nadat describe_entities heeft getoond welke entiteit de gegevens bevat en describe_entity de velden heeft opgesomd. De tool neemt de volgende argumenten:

  • entity: de naam van de entiteit, zoals describe_entities deze teruggeeft. Verplicht.
  • select: een door komma's gescheiden lijst van veldnamen, zoals describe_entity ze teruggeeft, in de $select-notatie van de query-interface van OData-versie 4.
  • filter: de voorwaarde waaraan de rijen moeten voldoen, in de $filter-notatie, met de operatoren eq, ne, gt, ge, lt, le, and, or en not.
  • orderby: een lijst van velden met een richting, in de notatie $orderby, zoals AmountDC desc.
  • first: het maximale aantal rijen dat wordt gelezen. Als dit wordt weggelaten, wordt elke rij gelezen die aan het filter voldoet.

De lezing wordt vertaald naar een select-statement en uitgevoerd onder de autorisatie van de ingelogde gebruiker. De rijen komen terug als gestructureerde inhoud, één object per rij met de geselecteerde velden. Er is geen cursor en geen paginering. Een AI-client geeft first op, tenzij hij de volledige set wil, en beperkt het antwoord met filter en orderby.

Een veld of literal dat de OData-parser niet kent, wordt geweigerd met foutcode itgenmcp640. Wanneer de weigering een veld betreft, noemt de hint de velden van de entiteit die het meest lijken op het gevraagde. Datums en getallen worden zonder aanhalingstekens geschreven.

De volgende argumenten lezen de vijf grootste openstaande facturen van een entiteit:

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

Een lezing analyseren

analyze_records neemt de argumenten van read_records: entity, dat verplicht is, en select, filter, orderby en first. De lezing wordt vertaald naar hetzelfde select-statement, uitgevoerd onder dezelfde autorisatie en op dezelfde manier vastgelegd. De rijen worden gelezen en geteld, maar niet teruggegeven. Het antwoord bevat:

  • sqlStatement: het uitgevoerde select-statement.
  • rowsReturned en rowsRead: de rijen die het statement heeft teruggegeven en de rijen die het uit alle tabellen heeft gelezen.
  • counters: wat het statement heeft geteld, opgeteld over alle stappen, zoals PairsEvaluated of RowsSorted; alleen de tellers die niet nul zijn.
  • steps: één object per stap van de uitvoering, zoals het lezen van een tabel, een join of een sortering, met dezelfde leden als een regel van het /steps-bestand van Invantive Data Hub: het soort en de beschrijving van de stap, de rijen in en uit, de duur, processortijd en geheugentoewijzing inclusief de stappen hieronder, dezelfde cijfers zonder de stappen hieronder zoals explain analyze ze meet, hoe een join zijn rijen heeft gekoppeld, het aantal rijen dat een tabel opgeeft, en de tellers van de stap zelf. De leden van een stap worden geschreven zoals op die regel, beginnend met een hoofdletter, zoals ExclusiveCpuMs.

Een AI-client roept het aan wanneer een lezing traag is of meer rijen leest dan er teruggegeven worden, bijvoorbeeld om te zien of een filter aan de datacontainer is doorgegeven, welk join-algoritme is gekozen, of welke stap geheugen heeft toegewezen. Het meten van elke stap kost een meting van de processortijd per rij per stap, en alleen deze tool brengt die kosten in rekening.

De volgende argumenten analyseren de lezing van de vijf grootste openstaande facturen van een entiteit, met dezelfde argumenten die read_records zou gebruiken:

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

De huidige gebruiker lezen

current_cloud_user geeft het profiel terug van de ingelogde gebruiker en van de organisatie van die gebruiker, zoals opgeslagen in Invantive Cloud. Een AI-client roept deze aan wanneer het antwoord afhangt van wie vraagt of tot welke organisatie de gegevens behoren. De tool neemt geen argumenten en leest niets uit de database.

Het antwoord bevat de volgende leden van de gebruiker:

  • Uid, Iwid en CognitoUserId: de identificaties van de gebruiker, van de webgebruiker en bij de identity provider.
  • Name, GivenName en FamilyName: de volledige naam, de voornaam en de achternaam.
  • Gender: M voor man, F voor vrouw en U voor onbekend.
  • JobTitle: de functietitel.
  • EmailAddress, PhoneNumber en MobileNumber: hoe de gebruiker bereikt kan worden.
  • LanguageCode: de taal in ISO-639-1-formaat. De standaardtaal van de service wordt gebruikt wanneer de gebruiker er geen heeft.
  • CreatedUtc en ModifiedUtc: wanneer de gebruiker is aangemaakt en voor het laatst gewijzigd.
  • LogInStartUtc en LogInEndUtc: de periode waarin de gebruiker kan inloggen.
  • UserIconUrl en UserIcon: het miniatuur van de gebruiker als adres en in binaire vorm.

Het antwoord bevat de volgende leden van de organisatie van de gebruiker:

  • PartyName: de naam van de organisatie. De naam in het profiel van de gebruiker wordt eerst gebruikt, en de naam die de organisatie zelf heeft wanneer het profiel er geen heeft. De terugvalmogelijkheid is beschikbaar vanaf release 27.0.
  • PartyAddressLine1, PartyAddressLine2, PartyAddressLine3, PartyPostalCode, PartyCity en PartyCountry: het adres. Het land van de organisatie wordt eerst gebruikt, en het land in het profiel van de gebruiker wanneer de organisatie er geen heeft. De terugvalmogelijkheid is beschikbaar vanaf release 27.0.
  • PartyEmailAddress, PartyPhone en PartyWebSite: hoe de organisatie bereikt kan worden.
  • PartyLegalStructure: de juridische structuur, zoals NL-BV.
  • PartyCoCNumber, PartyVatNumber, PartyIban en PartyBic: het KvK-nummer, het btw-nummer, het IBAN en de BIC.

De leden PartyCurrencyCode, PartyState, PartyGlnNumber, PartyRsinNumber, PartySiretNumber, PartyPaypalIdentifier en PartyWageTaxNumber maken deel uit van het antwoord, maar de service vult ze niet in. Invantive Cloud heeft hiervoor geen waarde.

SQL-syntaxis controleren

check_sql parseert een of meer Invantive UniversalSQL- en PSQL-statements, gescheiden door ;, zonder ze uit te voeren en zonder de database te lezen. Een AI-client roept het aan voor een statement dat hij heeft geschreven voor Invantive Data Hub, Invantive Query Tool of een script, voordat het statement budget kost of gegevens wijzigt. Namen van tabellen en kolommen worden niet gecontroleerd, omdat daarvoor de database nodig is. Beschikbaar vanaf release 28.0.

De tool neemt één argument, sql, met maximaal 1,000,000 tekens. Het antwoord bevat:

  • Valid: true wanneer de instructies aan de grammatica voldoen.
  • MessageCode, Message en Hint: de syntaxfout, het bericht ervan met een uittreksel en accenttekens, en wat u moet doen. De codes worden uitgelegd in Syntax Errors.
  • Url: het adres van het deel van de berichtcode in Syntax Errors.
  • Position: Line en Column, geteld vanaf 1 met een tab als één kolom, Offset, geteld vanaf 0 in de tekst, en Length, het aantal gemarkeerde tekens.
  • Syntax: Kind zoals missing of premature-end, Expected met wat op die positie geldig is, als lijst van niet-vertaalde items zoals FROM, ,, name of expression, en Context met het deel van de instructie, zoals whereClause.

Een syntaxisfout is het antwoord van de tool en niet een mislukking ervan: het resultaat wordt niet als fout gemarkeerd.

Hulpmiddelen voor Invantive Cloud Status

De statushulpmiddelen laten een AI-client een statuspagina van Invantive Cloud Status lezen en onderhouden, bijvoorbeeld om te beantwoorden of een dienst uitligt of om een storing te melden. Ze worden alleen aangeboden op een server waar de instellingen StatusPage:Server en StatusPage:ApiToken zijn ingesteld: het adres van de statusserver, zoals https://statuspage.invantive.eu, en een API-token van één tenant, aangemaakt onder "Settings" en "API tokens". StatusPage:TimeoutSec stelt het aantal seconden in dat een aanroep mag duren, met een standaardwaarde van 20. De tools zijn nog niet uitgebracht.

De tools werken op de pagina's van de tenant van het token. Een token met scope read is voldoende voor de drie tools die lezen. De vier tools die de statuspagina wijzigen hebben een token met scope write nodig; met een token met scope read weigert de statusserver ze. Een wijziging is direct zichtbaar voor lezers en kan abonnees een melding sturen, daarom wordt de AI-client gevraagd de tekst met de gebruiker te bevestigen voordat de tool wordt aangeroepen.

De statussen van een component zijn operational, degraded_performance, partial_outage, major_outage en under_maintenance. De fasen van een incident zijn investigating, identified, monitoring en resolved.

status_get_summary heeft geen argumenten. Het antwoord bevat:

  • overallState: de ernstigste status over de componenten die meetellen voor de algemene status.
  • componentCount: het aantal componenten.
  • componentsNotOperational: per component dat niet operationeel is de component-code, name, state en het moment since waarop het die status heeft.
  • openIncidents: per incident dat niet is opgelost de publicId, title, phase, impact en startedAt.
  • maintenance: het onderhoud dat wordt uitgevoerd of binnen zeven dagen gepland staat, met publicId, title, phase, windowStart en windowEnd.

status_list_incidents heeft twee optionele argumenten:

  • openOnly: indien true, alleen incidenten die niet zijn opgelost. Standaard is false.
  • first: het aantal van de nieuwste incidenten dat moet worden teruggegeven, van 1 tot 100. De standaardinstelling is 20.

Het antwoord bevat incidents, met dezelfde leden per incident als openIncidents van status_get_summary.

status_get_incident neemt de publicId van een incident, zoals 2026-0187. Het antwoord is het incident zoals de beheer-API van de statusserver het teruggeeft, met de getroffen componenten en hun status, de tijdlijn van updates met hun fase en de versie.

status_create_incident neemt:

  • title: de titel die lezers zien. Verplicht.
  • message: de eerste update, voor klanten.
  • impact: een van none, minor, major of critical. De standaardinstelling is minor.
  • phase: de fase van de eerste update. De standaardinstelling is investigating.
  • template: de code van een incidentsjabloon, dat vult wat niet is opgegeven.
  • components: de getroffen componenten, elk met hun component-code en de state die ze krijgen zolang het incident open is.

status_add_update neemt:

  • publicId: de publieke id van het incident. Verplicht.
  • message: de tekst van de update, voor klanten. Verplicht.
  • phase: de fase van de update. Verplicht. De fase resolved sluit het incident af en zet de componenten weer op operationeel.
  • internalNote: een notitie alleen voor operators, die nooit wordt gepubliceerd of verzonden.

status_set_component_state neemt:

  • component: de code van de component, zoals status_get_summary die teruggeeft. Verplicht.
  • state: de nieuwe status. Verplicht.
  • hold: indien true, veranderen de probes de status niet totdat een operator die vrijgeeft. Standaard is true.

status_schedule_maintenance neemt:

  • title: de titel die lezers zien. Verplicht.
  • message: wat er gebeurt en wat lezers merken. Verplicht.
  • windowStart en windowEnd: het begin en einde van het venster als ISO-8601-datum en -tijd met offset, zoals 2026-11-08T06:00:00+01:00. Verplicht.
  • components: de codes van de getroffen componenten.
  • autoStart: start het onderhoud aan het begin van het venster. Standaard is true.
  • autoComplete: voltooi het onderhoud aan het eind van het venster. Standaard is true.
  • muteProbes: dempt de probes van de getroffen componenten gedurende het venster. Standaard is true.

De tools die de statuspagina wijzigen, geven het incident, de component of het onderhoud terug zoals de statusserver die na de wijziging teruggeeft.

De omvang van een antwoord meten

Invantive MCP Server schrijft de grootte van elk antwoord in tekens naar de trace. De grootte is het aantal van de tracéregel met berichtcode itgenmcp664, die op het debug-niveau wordt geschreven. Het telt de gestructureerde inhoud en de tekstblokken van het antwoord op, en het bericht noemt de tool, de database en beide onderdelen. De regel is geschreven voor een antwoord dat geslaagd is en voor een antwoord dat is mislukt, omdat de AI-client beide in zijn context leest. De envelop van het JSON-RPC-bericht wordt niet meegeteld. Beschikbaar vanaf release 27.0.

Wanneer een tool faalt

Een tool die faalt, geeft een antwoord met isError ingesteld en de details in de gestructureerde inhoud, zodat de AI-client de gebruiker kan vertellen wat te doen. Het antwoord bevat:

  • Message en MessageCode: wat er misging, en de code om te noemen bij het vragen om hulp.
  • KindRequest: de hint, dat is de volgende stap voor de AI-client of de gebruiker. Elk antwoord heeft er een. Wanneer geen specifieke hint bekend is, staat erin of het verzoek opnieuw verstuurd moet worden, gecorrigeerd moet worden, of de gebruiker geïnformeerd moet worden.
  • NaturalKey: waar het bericht over gaat, zoals de database of de gevraagde entiteit.
  • IsRecoverable: true wanneer het later opnieuw versturen van hetzelfde verzoek kan slagen en false wanneer dat niet kan. Het wordt weggelaten wanneer niets een van beide aangeeft.
  • RetryAfterSec: het aantal seconden dat de service adviseert te wachten voordat hetzelfde verzoek opnieuw wordt verstuurd, van een vergrendeling of uit de Retry-After-header van het platform. Het is alleen aanwezig wanneer IsRecoverable true is en een wachttijd is geadviseerd; er wordt geen wachttijd verzonnen. Wanneer de wachttijd langer is dan 60 seconden, vertelt de hint de AI-client de wachttijd aan de gebruiker over te laten. Beschikbaar vanaf release 27.0.
  • Actor: wie moet eerst handelen. ai wanneer de AI-client het verzoek kan corrigeren of kan wachten en het opnieuw kan sturen, user wanneer een persoon moet beslissen of buiten het gesprek moet handelen, zoals bij een licentie, een IP-adres of een inlog, en forums wanneer niemand het in het gesprek kan oplossen, zodat de referentie en berichtcode worden opgezocht of gemeld op de forums. Een wachttijd van meer dan 60 seconden is aan de gebruiker. Beschikbaar vanaf release 27.0.
  • HelpUrl: het adres van het forumonderwerp of de helppagina over de berichtcode, indien bekend. Beschikbaar vanaf release 27.0.
  • Uid: de referentie van de fout, om aan de support door te geven.

Een verzoek om een entiteit of veld die niet bestaat, noemt in de hint de dichtstbijzijnde bestaande namen. describe_entities doet hetzelfde voor de namen in het argument entities, in unknownEntitiesHint. Beide zijn beschikbaar vanaf release 27.0.

Een verzoek van een IP-adres dat niet is geautoriseerd voor de database wordt geweigerd met berichtcode itgenmcp326. Het bericht noemt het adres en de hint noemt de database waaraan het moet worden toegevoegd.

Een statustool die mislukt, antwoordt op dezelfde manier. Wanneer de statusserver de aanroep weigert, bevat MessageCode de berichtcode van de statusserver, of itgenmst001 wanneer het antwoord er geen bevat. Een weigering wegens ontbrekende scope write vraagt de gebruiker om een token met scope write aan te vragen. itgenmst002 betekent dat de statustools niet zijn geconfigureerd op de server, en itgenmst003 dat de statusserver niet bereikbaar is.

Release Notes