Documentation Invantive
Forums d'Invantive SupportConnectez-vous/inscrivez-vous

Outils

Invantive MCP Server propose les outils suivants à un client d'IA tel qu'Anthropic Claude. Les outils sur une base de données ne font que lire : ils ne modifient aucune donnée et n'exécutent aucune instruction SQL. Seul check_sql en accepte un, qu'il analyse sans l'exécuter. Les outils d'état travaillent sur une page d'état d'Invantive Cloud Status au lieu d'une base de données ; quatre d'entre eux modifient la page d'état.

  • describe_entities : liste les entités pouvant être lues depuis la base de données, avec leur nom, leur libellé, leur type, leur conteneur de données et l'ordre de grandeur de leur nombre de lignes. Disponible à partir de la version 26.0. Voir ci-dessous.
  • describe_entity : décrit une entité en détail, avec ses champs, sa clé primaire, ses clés uniques, ses clés étrangères et la vitesse à attendre. Disponible à partir de la version 27.0. Voir ci-dessous.
  • read_records : lit des lignes d'une entité, avec un select, un filtre, un tri et un nombre de lignes dans la notation de l'interface de requête OData version 4. Disponible à partir de la version 26.0. Voir ci-dessous.
  • analyze_records : exécute la même lecture que read_records et renvoie comment elle a été exécutée au lieu des lignes. Disponible à partir de la version 28.0. Voir ci-dessous.
  • current_cloud_user : renvoie le profil de l'utilisateur connecté et de l'organisation de cet utilisateur, tel que conservé dans Invantive Cloud. Disponible à partir de la version 26.0. Voir ci-dessous.
  • check_sql : vérifie la syntaxe des instructions Invantive UniversalSQL et PSQL sans les exécuter. Disponible à partir de la version 28.0. Voir ci-dessous.
  • status_get_summary : renvoie l'état de la page d'état en un coup d'œil. Voir ci-dessous.
  • status_list_incidents : liste les incidents de la page d'état, du plus récent au plus ancien. Voir ci-dessous.
  • status_get_incident : renvoie un incident avec ses composants et ses mises à jour. Voir ci-dessous.
  • status_create_incident : ouvre un incident sur la page d'état. Voir ci-dessous.
  • status_add_update : publie une mise à jour sur un incident, qui peut le résoudre. Voir ci-dessous.
  • status_set_component_state : définit l'état d'un composant. Voir ci-dessous.
  • status_schedule_maintenance : planifie une maintenance avec une fenêtre. Voir ci-dessous.

Instructions destinées au client

Lorsqu'un client d'IA se connecte, le serveur lui envoie des instructions. Elles indiquent la version du serveur et les adresses auxquelles la même base de données est disponible pour d'autres clients, avec l'indication si l'utilisateur a activé chaque adresse : Invantive MCP Server, le protocole SQL Server d'Invantive UniversalSQL Server pour les clients SQL Server et ODBC, Bridge Online pour Power BI et App Online pour les applications, tous deux via OData version 4. Elles donnent aussi des conseils pour lire efficacement, indiquent les limites de débit des plateformes et renvoient vers Invantive Data Hub.

Les instructions indiquent également qu'Invantive Cloud peut échanger des données entre la base de données et d'autres plateformes, en les répliquant, en les combinant ou en les intégrant. Elles énumèrent les noms commerciaux de ces plateformes, tels qu'Exact Online, Salesforce et AFAS Profit. La liste contient les plateformes pour lesquelles Invantive Cloud dispose d'un pilote. Les pilotes de test, les assistants, les pilotes obsolètes et les produits propres d'Invantive sont exclus. La liste est disponible à partir de la version 27.0.

Liste des entités

describe_entities liste les entités de la base de données pouvant être lues, afin qu'un client d'IA puisse en choisir une. Il ne décrit pas une entité en détail : describe_entity le fait pour une seule entité. L'outil accepte deux arguments, tous deux facultatifs :

  • entities : les noms des entités à lister. Un nom est reconnu sans tenir compte de la casse et doit être écrit tel qu'une réponse précédente l'a renvoyé. Un seul nom ou une liste séparée par des virgules est accepté à la place d'un tableau.
  • nameOnly : lorsqu'il vaut true, chaque entité est réduite à son nom, son libellé, son type et son conteneur de données. Utilisez-le uniquement lorsque la réponse a été tronquée. La valeur par défaut est false.

La réponse contient :

  • database : le segment d'URL de la base de données.
  • detailLevel : summary, ou namesOnly lorsque nameOnly est appliqué.
  • entityCount et returnedEntityCount : le nombre d'entités correspondant à la demande et le nombre d'entités dans la réponse.
  • truncated et truncationHint : présents lorsque la réponse contient moins d'entités que de correspondances. L'indication explique comment poser une question plus précise, en nommant les entités recherchées dans entities.
  • unknownEntities et unknownEntitiesHint : présents lorsque entities contient un nom qui n'existe pas. L'indication nomme les entités existantes les plus proches pour au plus les cinq premiers noms inconnus. unknownEntitiesHint est disponible à partir de la version 27.0.
  • dataContainers : un objet par conteneur de données, car le partitionnement appartient au conteneur de données et non à l'entité. Il contient le alias que porte un nom d'entité après @, le provider qui sert le conteneur de données et indique si celui-ci supportsPartitions. Un conteneur de données qui prend en charge les partitions contient aussi partitionLabelPlural, partitionCount, selectedPartitionCount et allPartitionsSelected : le terme qu'emploie la plateforme pour plusieurs partitions, tel que divisions sur Exact Online, le nombre de partitions disponibles, le nombre qu'un appel de read_records interroge, et si ce sont toutes les partitions.
  • partitioningNote : le lien entre le partitionnement et les entités de cette base de données. Présent lorsqu'au moins un conteneur de données prend en charge les partitions.
  • selectedPartitionCountTotal : le nombre de partitions sélectionnées sur l'ensemble des conteneurs de données.
  • entities : un objet par entité, trié par conteneur de données puis par nom, de sorte qu'une réponse tronquée omette les mêmes entités à chaque appel.

Une entité contient :

  • name : le nom à transmettre dans l'argument entity de read_records et describe_entity.
  • label : le libellé utilisé par la plateforme pour le contenu. Présent uniquement lorsqu'il diffère de name.
  • type : le type d'objet, comme table, view ou tablefunction.
  • dataContainer : l'alias du conteneur de données qui contient l'entité.
  • rowCountBand : l'ordre de grandeur du nombre de lignes, lorsque la plateforme fournit une estimation. La valeur est empty, <=100, <=1k, <=10k, <=100k, <=1M ou >1M.
  • notReadable : vrai lorsque l'entité ne peut pas être lue. Absent sinon.

Les membres rowCountBand et notReadable sont omis lorsque nameOnly est appliqué.

Jusqu'à la version 26.0 incluse, chaque entité détenait également description, keyField et partitionSpecific, et un conteneur de données détenait l'ensemble du partitionnement : les termes, la colonne de partition et les partitions sélectionnées. À partir de la version 27.0, ceux-ci figurent dans la réponse de describe_entity. Cela maintient la liste courte et rapide sur une base de données comptant plus de mille entités.

La taille de la réponse est limitée à 60,000 caractères par défaut. Le paramètre MaxDescribeEntitiesResponseChars modifie cette limite. Elle est disponible à partir de la version 26.0. Le paramètre MaxEntityDescriptionChars n'est plus utilisé à partir de la version 27.0, car la liste ne contient aucune description.

Les arguments suivants listent deux entités de la base de données :

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

Description d'une entité

describe_entity décrit une entité en détail. Un client IA l'appelle avec un nom issu de describe_entities, avant de lire l'entité avec read_records. Elle est disponible à partir de la version 27.0. L'outil prend un seul argument :

  • entity : le nom de l'entité, tel que describe_entities le renvoie. Un nom est comparé sans tenir compte de la casse. Obligatoire.

Un nom qui n'existe pas est refusé avec le code de message itgenmcp665. L'indication nomme les entités existantes les plus proches.

La réponse contient :

  • database : le segment d'URL de la base de données.
  • name, label, labelSingular, type et dataContainer : comme dans la liste. label et labelSingular ne sont présents que lorsqu'ils diffèrent de name.
  • description : ce que contient l'entité, rédigé pour un utilisateur métier et de manière complète. documentation est une explication complémentaire, lorsque la plateforme en fournit une.
  • partitionSpecific : vrai lorsque le contenu dépend des partitions sélectionnées. Absent sinon.
  • notReadable : vrai lorsque l'entité ne peut pas être lue. Absent sinon.
  • rowCountBand et estimatedRowCount : l'ordre de grandeur du nombre de lignes et l'estimation elle-même, lorsque la plateforme en fournit une. Une estimation n'est pas un comptage.
  • performance : ce qu'il faut attendre de la vitesse de lecture de l'entité.
  • primaryKey, uniqueKeys et foreignKeys : les clés et les relations avec d'autres entités.
  • dataContainerDetails et partitioningNote : le conteneur de données qui contient l'entité et le lien entre le partitionnement et l'entité.
  • fieldCount, returnedFieldCount, truncated et truncationHint : le nombre de champs, le nombre dans la réponse et, lorsque des champs sont omis, ce qu'il faut faire à ce sujet.
  • fields : les champs de l'entité.

Un champ contient :

  • name : le nom tel que les arguments select, filter et orderby de read_records l'acceptent.
  • label : le libellé utilisé par la plateforme. Présent uniquement lorsqu'il diffère de name.
  • dataType : le type primitif OData version 4, tel que String, Int32, Decimal, DateTimeOffset, Boolean ou Guid.
  • nullable : indique si le champ peut être vide.
  • maxLength, precision et scale : la longueur d'un champ texte ou binaire et le nombre de chiffres d'un champ décimal, lorsque la plateforme les indique.
  • primaryKey : vrai lorsque le champ fait partie de la clé primaire. Absent sinon.
  • description : ce que contient le champ, rédigé pour un utilisateur métier.
  • filterOnPlatform : vrai lorsque la plateforme évalue elle-même un filtre sur le champ, de sorte que seules les lignes correspondantes sont récupérées. Faux lorsque chaque ligne est d'abord récupérée puis filtrée, ce qui est lent sur une entité volumineuse.
  • sortOnPlatform : vrai lorsque la plateforme elle-même trie sur le champ. Absent lorsque cela n'est pas connu.

Les membres uniqueKeys et foreignKeys, ainsi que le guarantee d'une clé, sont disponibles à partir de la version 28.0. La version 27.0 répond à la clé primaire sans garantie, car son moteur ne contient aucune autre métadonnée de clé.

Une clé contient fields, guarantee et, lorsque la plateforme en fournit une, name. La garantie est enforced lorsque la plateforme elle-même garantit l'unicité de la clé, et declared lorsque le pilote ou le modèle l'indique sans que la plateforme l'impose. Les champs d'une clé sont nommés comme les champs de l'entité. Un nom qui n'est pas un champ de l'entité est écrit tel que la plateforme nomme la colonne. Une clé qui reprend la clé primaire n'est pas listée dans uniqueKeys.

Une clé étrangère est une relation allant de champs de cette entité à la clé d'une autre entité. Il contient :

  • fields : les champs de cette entité qui contiennent la référence.
  • referencedEntity et referencedFields : l'entité référencée, telle que describe_entities la nomme, et ses champs, dans le même ordre que fields.
  • referencedTable : le nom que la plateforme donne à l'objet référencé. Présent uniquement lorsque cet objet n'est pas une entité de cette base de données, auquel cas referencedFields contient les noms de colonnes de la plateforme.
  • kind : key lorsque les champs renvoient à une clé de l'entité référencée, textual lorsque la relation n'existe qu'en mots et ne vaut que sous une condition, et candidate lorsqu'elle découle des noms des champs et se vérifie dans les données sans que la plateforme la déclare.
  • guarantee : enforced ou declared, comme pour une clé.
  • description : indique quand une relation textual ou candidate est valable. Une relation de ces types ne vaut pas pour toutes les lignes.
  • name : le nom de la clé étrangère sur la plateforme, lorsqu'elle en possède une.

Ce serveur lit une entité par appel et ne effectue pas de jointure. Un client IA lit les lignes liées par un second appel de read_records, en filtrant sur les valeurs de fields.

Les performances contiennent les membres suivants, lorsque le pilote de la plateforme les indique :

  • accessLatencyMs : le temps moyen d'un aller-retour vers la plateforme, en millisecondes.
  • fullScanRowsPerMinute : le nombre moyen de lignes par minute lorsque l'entité entière est lue.
  • pointQueryRowsPerMinute : le nombre moyen de lignes par minute lorsque les lignes sont lues par un filtre sur une clé.
  • estimatedFullScanSeconds : une estimation du temps nécessaire pour lire chaque ligne de l'entité, à partir de estimatedRowCount et fullScanRowsPerMinute. Il n'est présent que lorsque les deux sont connus.

Les chiffres sont des moyennes statiques du pilote pour la plateforme et non des mesures de cette base de données. La valeur pour l'écriture n'est pas renvoyée, car le serveur ne fait que lire. Un pilote qui ne fournit aucun chiffre laisse performance de côté.

La taille de la réponse est limitée à 60,000 caractères par défaut. Le paramètre MaxDescribeEntityResponseChars modifie cette limite et MaxSelectedPartitionsDescribed le nombre de partitions listées dans dataContainerDetails. Ils sont disponibles à partir des versions 27.0 et 26.0 respectivement. Lorsque les champs ne tiennent pas, les champs des clés passent en premier. Les clés, les relations et les performances ne sont jamais omises.

Les arguments suivants décrivent une entité de la base de données :

{ "entity": "SalesInvoices" }

Lecture des enregistrements

read_records lit les lignes d'une entité. Un client IA l'appelle une fois que describe_entities a indiqué quelle entité contient les données et que describe_entity a listé ses champs. L'outil prend les arguments suivants :

  • entity : le nom de l'entité, tel que describe_entities le renvoie. Obligatoire.
  • select : une liste de noms de champs séparés par des virgules, telle que describe_entity les renvoie, dans la notation $select de l'interface de requête OData version 4.
  • filter : la condition que doivent remplir les lignes, dans la notation $filter, avec les opérateurs eq, ne, gt, ge, lt, le, and, or et not.
  • orderby : une liste de champs avec un sens de tri, dans la notation $orderby, par exemple AmountDC desc.
  • first : le nombre maximal de lignes à lire. Lorsqu'il est omis, toutes les lignes qui correspondent au filtre sont lues.

La lecture est traduite en une instruction select et exécutée avec l'autorisation de l'utilisateur connecté. Les lignes sont renvoyées sous forme de contenu structuré, un objet par ligne avec les champs sélectionnés. Il n'y a ni curseur ni pagination. Un client IA transmet first sauf s'il souhaite l'ensemble complet, et affine la réponse avec filter et orderby.

Un champ ou un littéral que l'analyseur OData ne connaît pas est refusé avec le code de message itgenmcp640. Lorsque le refus concerne un champ, l'indication nomme les champs de l'entité les plus proches. Les dates et les nombres s'écrivent sans guillemets.

Les arguments suivants lisent les cinq plus grosses factures ouvertes d'une entité :

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

Analyse d'une lecture

analyze_records prend les arguments de read_records : entity, qui est obligatoire, et select, filter, orderby et first. La lecture est traduite dans la même instruction select, exécutée avec la même autorisation et enregistrée de la même manière. Ses lignes sont lues et comptées, mais non renvoyées. La réponse contient :

  • sqlStatement : l'instruction select qui a été exécutée.
  • rowsReturned et rowsRead : les lignes renvoyées par l'instruction et les lignes lues dans toutes les tables.
  • counters : ce que l'instruction a compté, additionné pour toutes les étapes, par exemple PairsEvaluated ou RowsSorted ; seulement les compteurs qui ne sont pas à zéro.
  • steps : un objet par étape d'exécution, telle que la lecture d'une table, une jointure ou un tri, avec les mêmes membres qu'une ligne du fichier /steps de Invantive Data Hub : le type et la description de l'étape, les lignes en entrée et en sortie, la durée, le temps processeur et l'allocation, y compris les étapes ci-dessous, les mêmes chiffres sans les étapes ci-dessous tels que explain analyze les mesure, la manière dont une jointure a associé ses lignes, le nombre de lignes qu'une table déclare, et les compteurs de l'étape elle-même. Les membres d'une étape sont écrits comme sur cette ligne, commençant par une majuscule, par exemple ExclusiveCpuMs.

Un client IA l'appelle lorsqu'une lecture est lente ou lit plus de lignes qu'elle n'en renvoie, par exemple pour vérifier si un filtre a été transmis au conteneur de données, quel algorithme de jointure a été choisi, ou quelle étape a alloué la mémoire. Mesurer chaque étape coûte une lecture du temps processeur par ligne et par étape, ce que seul cet outil fait.

Les arguments suivants analysent la lecture des cinq plus grosses factures ouvertes d'une entité, avec les mêmes arguments que read_records prendrait :

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

Lecture de l'utilisateur actuel

current_cloud_user renvoie le profil de l'utilisateur connecté et de l'organisation de cet utilisateur, tel que conservé dans Invantive Cloud. Un client IA l'appelle lorsque la réponse dépend de la personne qui demande ou de l'organisation à laquelle appartiennent les données. L'outil ne prend aucun argument et ne lit rien dans la base de données.

La réponse contient les membres suivants de l'utilisateur :

  • Uid, Iwid et CognitoUserId : les identifiants de l'utilisateur, de l'utilisateur web et chez le fournisseur d'identité.
  • Name, GivenName et FamilyName : le nom complet, le prénom et le nom de famille.
  • Gender : M pour masculin, F pour féminin et U pour inconnu.
  • JobTitle : le titre du poste.
  • EmailAddress, PhoneNumber et MobileNumber : comment joindre l'utilisateur.
  • LanguageCode : la langue au format ISO 639-1. La langue par défaut du service est utilisée lorsque l'utilisateur n'en a pas.
  • CreatedUtc et ModifiedUtc : la date de création et de dernière modification de l'utilisateur.
  • LogInStartUtc et LogInEndUtc : la période pendant laquelle l'utilisateur peut se connecter.
  • UserIconUrl et UserIcon : la miniature de l'utilisateur sous forme d'adresse et en binaire.

La réponse contient les membres suivants de l'organisation de l'utilisateur :

  • PartyName : le nom de l'organisation. Le nom du profil de l'utilisateur est utilisé en premier, et le nom détenu par l'organisation elle-même lorsque le profil n'en a pas. La solution de repli est disponible à partir de la version 27.0.
  • PartyAddressLine1, PartyAddressLine2, PartyAddressLine3, PartyPostalCode, PartyCity et PartyCountry : l'adresse. Le pays de l'organisation est utilisé en premier, et le pays du profil de l'utilisateur lorsque l'organisation n'en a aucun. La solution de repli est disponible à partir de la version 27.0.
  • PartyEmailAddress, PartyPhone et PartyWebSite : comment joindre l'organisation.
  • PartyLegalStructure : la forme juridique, comme NL-BV.
  • PartyCoCNumber, PartyVatNumber, PartyIban et PartyBic : le numéro d'immatriculation à la Chambre de commerce, le numéro de TVA, l'IBAN et le BIC.

Les membres PartyCurrencyCode, PartyState, PartyGlnNumber, PartyRsinNumber, PartySiretNumber, PartyPaypalIdentifier et PartyWageTaxNumber font partie de la réponse, mais le service ne les renseigne pas. Invantive Cloud ne fournit aucune valeur pour ceux-ci.

Vérification de la syntaxe SQL

check_sql analyse une ou plusieurs instructions Invantive UniversalSQL et PSQL, séparées par ;, sans les exécuter et sans lire la base de données. Un client IA l'appelle sur une instruction qu'il a écrite pour Invantive Data Hub, Invantive Query Tool ou un script, avant que l'instruction ne consomme un budget ou ne modifie des données. Les noms de tables et de colonnes ne sont pas vérifiés, car cela nécessite la base de données. Disponible à partir de la version 28.0.

L'outil prend un argument, sql, d'au plus 1,000,000 caractères. La réponse contient :

  • Valid : true lorsque les instructions respectent la grammaire.
  • MessageCode, Message et Hint : l'erreur de syntaxe, son message avec un extrait et des marqueurs, et ce qu'il faut faire. Les codes sont expliqués dans Syntax Errors.
  • Url : l'adresse de la section du code du message dans Syntax Errors.
  • Position : Line et Column, comptés à partir de 1 avec une tabulation comme une colonne, Offset, comptés à partir de 0 dans le texte, et Length, le nombre de caractères marqués.
  • Syntax : Kind comme missing ou premature-end, Expected avec ce qui est valide à cet endroit, sous forme de liste d'éléments non traduits comme FROM, ,, name ou expression, et Context avec la partie de l'instruction comme whereClause.

Une erreur de syntaxe est la réponse de l'outil et non une défaillance de celui-ci : le résultat n'est pas marqué comme erreur.

Outils sur Invantive Cloud Status

Les outils de statut permettent à un client IA de lire et de tenir à jour une page de statut d'Invantive Cloud Status, par exemple pour répondre si un service est en panne ou pour signaler une interruption. Ils ne sont proposés que sur un serveur où les paramètres StatusPage:Server et StatusPage:ApiToken sont renseignés : l'adresse du serveur de statut, par exemple https://statuspage.invantive.eu, et un jeton API d'un locataire, créé sous « Settings » puis « API tokens ». StatusPage:TimeoutSec définit le nombre de secondes pendant lesquelles un appel peut durer, avec une valeur par défaut de 20. Les outils ne sont pas encore publiés.

Les outils agissent sur les pages du locataire du jeton. Un jeton de portée read suffit pour les trois outils de lecture. Les quatre outils qui modifient la page d'état nécessitent un jeton de portée write ; avec un jeton de portée read, le serveur d'état les refuse. Une modification est immédiatement visible par les lecteurs et peut notifier les abonnés ; le client IA est donc invité à faire confirmer le texte par l'utilisateur avant l'appel.

Les états d'un composant sont operational, degraded_performance, partial_outage, major_outage et under_maintenance. Les phases d'un incident sont investigating, identified, monitoring et resolved.

status_get_summary n'accepte aucun argument. La réponse contient :

  • overallState : l'état le plus grave parmi les composants qui comptent pour l'état global.
  • componentCount : le nombre de composants.
  • componentsNotOperational : pour chaque composant qui n'est pas opérationnel, son code component, name, state et le moment since où il présente cet état.
  • openIncidents : pour chaque incident non résolu, son publicId, title, phase, impact et startedAt.
  • maintenance : la maintenance en cours ou planifiée dans les sept jours, avec publicId, title, phase, windowStart et windowEnd.

status_list_incidents accepte deux arguments facultatifs :

  • openOnly : si vrai, seuls les incidents non résolus sont renvoyés. La valeur par défaut est false.
  • first : le nombre des incidents les plus récents à renvoyer, de 1 à 100. La valeur par défaut est 20.

La réponse contient incidents, avec les mêmes membres par incident que openIncidents de status_get_summary.

status_get_incident prend le publicId d'un incident, comme 2026-0187. La réponse est l'incident tel que l'API de gestion du serveur de statut le renvoie, avec les composants concernés et leur état, sa chronologie de mises à jour avec leur phase, et sa version.

status_create_incident accepte :

  • title : le titre tel que le voient les lecteurs. Obligatoire.
  • message : la première mise à jour, destinée aux clients.
  • impact : l'une de none, minor, major ou critical. La valeur par défaut est minor.
  • phase : la phase de la première mise à jour. La valeur par défaut est investigating.
  • template : le code d'un modèle d'incident, qui remplit ce qui n'est pas indiqué.
  • components : les composants touchés, chacun avec son code component et le state qu'il reçoit tant que l'incident est ouvert.

status_add_update accepte :

  • publicId : l'identifiant public de l'incident. Obligatoire.
  • message : le texte de la mise à jour, destiné aux clients. Obligatoire.
  • phase : la phase de la mise à jour. Obligatoire. La phase resolved clôt l'incident et remet ses composants en fonctionnement normal.
  • internalNote : une note réservée aux opérateurs, qui n'est jamais publiée ni envoyée.

status_set_component_state accepte :

  • component : le code du composant, tel que status_get_summary le renvoie. Obligatoire.
  • state : le nouvel état. Obligatoire.
  • hold : si true, les sondes ne modifient pas l'état tant qu'un opérateur ne le libère pas. La valeur par défaut est true.

status_schedule_maintenance accepte :

  • title : le titre tel que le voient les lecteurs. Obligatoire.
  • message : ce qui se produit et ce que les lecteurs remarquent. Obligatoire.
  • windowStart et windowEnd : le début et la fin de la fenêtre, sous forme de date et heure ISO 8601 avec décalage horaire, par exemple 2026-11-08T06:00:00+01:00. Obligatoire.
  • components : les codes des composants concernés.
  • autoStart : démarre la maintenance au début de la fenêtre. La valeur par défaut est true.
  • autoComplete : termine la maintenance à la fin de la fenêtre. La valeur par défaut est true.
  • muteProbes : désactive les sondes des composants concernés pendant la fenêtre. La valeur par défaut est true.

Les outils qui modifient la page d'état renvoient l'incident, le composant ou la maintenance tel que le serveur d'état le renvoie après la modification.

Suivi de la taille d'une réponse

Invantive MCP Server écrit la taille de chaque réponse dans la trace, en caractères. La taille correspond à la quantité de la ligne de trace portant le code de message itgenmcp664, écrite au niveau debug. Il additionne le contenu structuré et les blocs de texte de la réponse, et le message nomme l'outil, la base de données et les deux parties. Le message est rédigé pour une réponse réussie comme pour une réponse en échec, car le client d'IA la lit dans son contexte. L'enveloppe du message JSON-RPC n'est pas comptée. Disponible à partir de la version 27.0.

Quand un outil échoue

Un outil en échec répond avec isError défini et les détails dans le contenu structuré, afin que le client IA puisse indiquer à l'utilisateur quoi faire. La réponse contient :

  • Message et MessageCode : ce qui a mal tourné, et le code à citer lorsqu'on demande de l'aide.
  • KindRequest : l'indication, c'est-à-dire l'étape suivante pour le client IA ou l'utilisateur. Chaque réponse en contient une. Lorsqu'aucune indication spécifique n'est connue, elle indique s'il faut renvoyer la requête, la corriger ou en informer l'utilisateur.
  • NaturalKey : l'objet du message, par exemple la base de données ou l'entité demandée.
  • IsRecoverable : true lorsque le renvoi ultérieur de la même requête peut réussir, false lorsque ce n'est pas le cas. Il est omis lorsque rien n'indique l'une ou l'autre.
  • RetryAfterSec : le nombre de secondes d'attente conseillé par le service avant de renvoyer la même requête, issu d'un blocage temporaire ou de l'en-tête Retry-After de la plateforme. Il n'est présent que lorsque IsRecoverable est true et qu'une attente a été conseillée ; aucune attente n'est inventée. Lorsque l'attente dépasse 60 secondes, l'indication demande au client IA de laisser l'attente à l'utilisateur. Disponible à partir de la version 27.0.
  • Actor : qui doit agir en premier. ai lorsque le client IA peut corriger la requête ou attendre pour la renvoyer, user lorsqu'une personne doit décider ou agir hors de la conversation, par exemple pour une licence, une adresse IP ou une connexion, et forums lorsque personne ne peut résoudre le problème dans la conversation, de sorte que la référence et le code de message sont à rechercher ou à signaler sur les forums. Une attente de plus de 60 secondes relève de l'utilisateur. Disponible à partir de la version 27.0.
  • HelpUrl : l'adresse du sujet du forum ou de la page d'aide concernant le code de message, lorsqu'elle est connue. Disponible à partir de la version 27.0.
  • Uid : la référence de l'erreur, à citer au support.

Une requête portant sur une entité ou un champ inexistant indique dans l'indication les noms existants les plus proches. describe_entities fait de même pour les noms de son argument entities, dans unknownEntitiesHint. Elles sont disponibles à partir de la version 27.0.

Une requête provenant d'une adresse IP non autorisée pour la base de données est refusée avec le code de message itgenmcp326. Le message nomme l'adresse et l'indication nomme la base de données à laquelle elle doit être ajoutée.

Un outil d'état en échec répond de la même manière. Lorsque le serveur d'état refuse l'appel, MessageCode contient le code de message du serveur d'état, ou itgenmst001 lorsque la réponse n'en contient aucun. Un refus pour absence de portée write invite l'utilisateur à demander un jeton de portée write. itgenmst002 signifie que les outils d'état ne sont pas configurés sur le serveur, et itgenmst003 que le serveur d'état est injoignable.

Notes de Version