Rechercher des articles

Nom de l'outilsearch_items
Lecture seuleIdempotent

Description

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

Liste ou recherche les articles Oxygenius (fournitures) et les ouvrages (composés d'articles), par ordre alphabétique, avec leur prix de vente et, si le module Stock est actif, la quantité en stock. Utiliser get_item pour le détail et get_item_stock pour le stock par emplacement.

Accès requis

Paramètres

NomTypePrésenceDescription
querystringfacultatifMots-clés : désignation, références interne et externe, code-barres, description, marque.
kindstringfacultatifall (défaut), article (fournitures) ou job (ouvrages).
categorystringfacultatifFragment du nom de la catégorie ou de la famille d'articles.
availabilitystringfacultatifModule Stock : all (défaut), in-stock (en stock), out-of-stock (rupture) ou below-minimum (sous le stock minimum).
includeInactivebooleanfacultatifInclure les articles désactivés (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 de l'article (à passer à get_item ou get_item_stock).
items[].kindstringarticle (fourniture stockable), job (ouvrage composé d'articles) ou other.
items[].namestringpeut être nullDésignation.
items[].internalReferencestringpeut être nullRéférence interne.
items[].externalReferencestringpeut être nullRéférence externe (fabricant, fournisseur).
items[].categorystringpeut être nullCatégorie (matériau, main d'œuvre…).
items[].familystringpeut être nullFamille d'articles.
items[].brandstringpeut être nullMarque.
items[].unitstringpeut être nullUnité de vente.
items[].salesPricenumberpeut être nullPrix de vente unitaire hors TVA, en euros.
items[].vatRatenumberpeut être nullTaux de TVA de vente en pourcents.
items[].isActivebooleanFaux pour un article désactivé.
items[].stockQuantitynumberpeut être nullQuantité totale en stock, tous emplacements (articles ; absent sans le module Stock).

Annotations MCP

AnnotationValeurSignification
titleRechercher des articlesNom 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_items",
  "title": "Rechercher des articles",
  "description": "Liste ou recherche les articles Oxygenius (fournitures) et les ouvrages (composés d'articles), par ordre alphabétique, avec leur prix de vente et, si le module Stock est actif, la quantité en stock. Utiliser get_item pour le détail et get_item_stock pour le stock par emplacement.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "query": {
        "description": "Mots-clés : désignation, références interne et externe, code-barres, description, marque.",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "kind": {
        "description": "all (défaut), article (fournitures) ou job (ouvrages).",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "category": {
        "description": "Fragment du nom de la catégorie ou de la famille d'articles.",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "availability": {
        "description": "Module Stock : all (défaut), in-stock (en stock), out-of-stock (rupture) ou below-minimum (sous le stock minimum).",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "includeInactive": {
        "description": "Inclure les articles désactivés (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 de l'article (à passer à get_item ou get_item_stock).",
              "type": "integer"
            },
            "kind": {
              "description": "article (fourniture stockable), job (ouvrage composé d'articles) ou other.",
              "type": "string"
            },
            "name": {
              "description": "Désignation.",
              "type": [
                "string",
                "null"
              ]
            },
            "internalReference": {
              "description": "Référence interne.",
              "type": [
                "string",
                "null"
              ]
            },
            "externalReference": {
              "description": "Référence externe (fabricant, fournisseur).",
              "type": [
                "string",
                "null"
              ]
            },
            "category": {
              "description": "Catégorie (matériau, main d'œuvre…).",
              "type": [
                "string",
                "null"
              ]
            },
            "family": {
              "description": "Famille d'articles.",
              "type": [
                "string",
                "null"
              ]
            },
            "brand": {
              "description": "Marque.",
              "type": [
                "string",
                "null"
              ]
            },
            "unit": {
              "description": "Unité de vente.",
              "type": [
                "string",
                "null"
              ]
            },
            "salesPrice": {
              "description": "Prix de vente unitaire hors TVA, en euros.",
              "type": [
                "number",
                "null"
              ]
            },
            "vatRate": {
              "description": "Taux de TVA de vente en pourcents.",
              "type": [
                "number",
                "null"
              ]
            },
            "isActive": {
              "description": "Faux pour un article désactivé.",
              "type": "boolean"
            },
            "stockQuantity": {
              "description": "Quantité totale en stock, tous emplacements (articles ; absent sans le module Stock).",
              "type": [
                "number",
                "null"
              ]
            }
          },
          "required": [
            "id",
            "kind",
            "isActive"
          ]
        }
      }
    },
    "required": [
      "totalCount",
      "offset",
      "limit",
      "hasMore",
      "items"
    ]
  },
  "annotations": {
    "title": "Rechercher des articles",
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": true
  }
}