Rechercher des tiers

Nom de l'outilsearch_tiers
Lecture seuleIdempotent

Description

Texte exact envoyé au modèle par tools/list :

Liste ou recherche les tiers (clients, fournisseurs, contacts) de l'entreprise de l'utilisateur dans Oxygenius. La recherche porte sur la référence, la raison sociale, le nom, le prénom, les courriels, l'adresse et les téléphones. Tous les mots du terme doivent être trouvés ; la casse et les accents sont ignorés. Résultats triés par dénomination. Utiliser get_tiers pour le détail d'un tiers.

Accès requis

Paramètres

NomTypePrésenceDescription
querystringfacultatifMots-clés : nom, société, référence, courriel, localité, téléphone… Laisser vide pour lister les tiers.
rolestringfacultatifcustomer (clients, c.-à-d. non fournisseurs), supplier (fournisseurs) ou all (défaut).
kindstringfacultatifcompany (sociétés), individual (personnes) ou all (défaut).
includeInactivebooleanfacultatifInclure les tiers en sommeil (faux par défaut).
Par défaut : false
limitintegerfacultatifNombre de résultats souhaités (10 par défaut, plafonné par le serveur).
Par défaut : 10
offsetintegerfacultatifNombre de résultats à sauter pour la pagination (0 par défaut).
Par défaut : 0

Résultat

Le résultat est renvoyé en contenu structuré (structuredContent), conforme au schéma de sortie ci-dessous, et en texte JSON pour les clients qui ne lisent pas le contenu structuré. Une erreur est renvoyée avec isError: true et un message en français qui explique quoi corriger.

Champs du résultat
NomTypePrésenceDescription
totalCountintegerNombre total d'éléments correspondant aux critères.
offsetintegerPosition du premier élément de la page.
limitintegerTaille de page appliquée (le serveur plafonne la valeur demandée).
hasMorebooleanVrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit.
itemsobject[]Éléments de la page.
items[].idintegerIdentifiant technique du tiers (à passer à get_tiers).
items[].referencestringpeut être nullRéférence du tiers.
items[].namestringDénomination : société, sinon nom et prénom.
items[].kindstringcompany (société renseignée) ou individual (personne).
items[].isSupplierbooleanVrai pour un fournisseur.
items[].isActivebooleanFaux si le tiers est en sommeil.
items[].emailstringpeut être nullCourriel principal.
items[].phonestringpeut être nullTéléphone principal.
items[].citystringpeut être nullCode postal et localité.

Annotations MCP

AnnotationValeurSignification
titleRechercher des tiersNom lisible affiché par le client MCP.
readOnlyHintouiL'outil ne modifie rien.
destructiveHintnonL'outil peut modifier ou supprimer des données existantes, ou déclencher une action irréversible.
idempotentHintouiRappeler l'outil avec les mêmes arguments n'a pas d'effet supplémentaire.
openWorldHintnonL'outil lit des courriels ou le contenu d'un document, ou contacte un service extérieur.

Définition JSON

Entrée exacte de tools/list
{
  "name": "search_tiers",
  "title": "Rechercher des tiers",
  "description": "Liste ou recherche les tiers (clients, fournisseurs, contacts) de l'entreprise de l'utilisateur dans Oxygenius. La recherche porte sur la référence, la raison sociale, le nom, le prénom, les courriels, l'adresse et les téléphones. Tous les mots du terme doivent être trouvés ; la casse et les accents sont ignorés. Résultats triés par dénomination. Utiliser get_tiers pour le détail d'un tiers.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "query": {
        "description": "Mots-clés : nom, société, référence, courriel, localité, téléphone… Laisser vide pour lister les tiers.",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "role": {
        "description": "customer (clients, c.-à-d. non fournisseurs), supplier (fournisseurs) ou all (défaut).",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "kind": {
        "description": "company (sociétés), individual (personnes) ou all (défaut).",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "includeInactive": {
        "description": "Inclure les tiers en sommeil (faux par défaut).",
        "type": "boolean",
        "default": false
      },
      "limit": {
        "description": "Nombre de résultats souhaités (10 par défaut, plafonné par le serveur).",
        "type": "integer",
        "default": 10
      },
      "offset": {
        "description": "Nombre de résultats à sauter pour la pagination (0 par défaut).",
        "type": "integer",
        "default": 0
      }
    }
  },
  "outputSchema": {
    "type": "object",
    "properties": {
      "totalCount": {
        "description": "Nombre total d'éléments correspondant aux critères.",
        "type": "integer"
      },
      "offset": {
        "description": "Position du premier élément de la page.",
        "type": "integer"
      },
      "limit": {
        "description": "Taille de page appliquée (le serveur plafonne la valeur demandée).",
        "type": "integer"
      },
      "hasMore": {
        "description": "Vrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit.",
        "type": "boolean"
      },
      "items": {
        "description": "Éléments de la page.",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "description": "Identifiant technique du tiers (à passer à get_tiers).",
              "type": "integer"
            },
            "reference": {
              "description": "Référence du tiers.",
              "type": [
                "string",
                "null"
              ]
            },
            "name": {
              "description": "Dénomination : société, sinon nom et prénom.",
              "type": "string"
            },
            "kind": {
              "description": "company (société renseignée) ou individual (personne).",
              "type": "string"
            },
            "isSupplier": {
              "description": "Vrai pour un fournisseur.",
              "type": "boolean"
            },
            "isActive": {
              "description": "Faux si le tiers est en sommeil.",
              "type": "boolean"
            },
            "email": {
              "description": "Courriel principal.",
              "type": [
                "string",
                "null"
              ]
            },
            "phone": {
              "description": "Téléphone principal.",
              "type": [
                "string",
                "null"
              ]
            },
            "city": {
              "description": "Code postal et localité.",
              "type": [
                "string",
                "null"
              ]
            }
          },
          "required": [
            "id",
            "name",
            "kind",
            "isSupplier",
            "isActive"
          ]
        }
      }
    },
    "required": [
      "totalCount",
      "offset",
      "limit",
      "hasMore",
      "items"
    ]
  },
  "annotations": {
    "title": "Rechercher des tiers",
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": true
  }
}