Rechercher des articles

Tool namesearch_items
Read-onlyIdempotent

Lists or searches catalogue items and assemblies alphabetically, with their sale price and, with the Stock module, the quantity in stock.

Description

Exact text sent to the model by tools/list (French, the language of the data):

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.

Required access

Parameters

NameTypePresenceDescription
querystringoptionalMots-clés : désignation, références interne et externe, code-barres, description, marque.
kindstringoptionalall (défaut), article (fournitures) ou job (ouvrages).
categorystringoptionalFragment du nom de la catégorie ou de la famille d'articles.
availabilitystringoptionalModule Stock : all (défaut), in-stock (en stock), out-of-stock (rupture) ou below-minimum (sous le stock minimum).
includeInactivebooleanoptionalInclure les articles désactivés (faux par défaut).
Default : false
limitintegeroptionalNombre de résultats souhaités (10 par défaut, plafonné par le serveur).
Default : 10
offsetintegeroptionalNombre de résultats à sauter pour la pagination (0 par défaut).
Default : 0

Result

The result is returned as structured content (structuredContent) matching the output schema below, and as JSON text for clients that do not read structured content. An error comes back with isError: true and a French message that explains what to fix.

Result fields
NameTypePresenceDescription
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[].namestringnullableDésignation.
items[].internalReferencestringnullableRéférence interne.
items[].externalReferencestringnullableRéférence externe (fabricant, fournisseur).
items[].categorystringnullableCatégorie (matériau, main d'œuvre…).
items[].familystringnullableFamille d'articles.
items[].brandstringnullableMarque.
items[].unitstringnullableUnité de vente.
items[].salesPricenumbernullablePrix de vente unitaire hors TVA, en euros.
items[].vatRatenumbernullableTaux de TVA de vente en pourcents.
items[].isActivebooleanFaux pour un article désactivé.
items[].stockQuantitynumbernullableQuantité totale en stock, tous emplacements (articles ; absent sans le module Stock).

MCP annotations

AnnotationValueMeaning
titleRechercher des articlesHuman-readable name shown by the MCP client.
readOnlyHintyesThe tool changes nothing.
destructiveHintnoThe tool may change or delete existing data, or trigger an irreversible action.
idempotentHintyesCalling it again with the same arguments has no further effect.
openWorldHintnoThe tool reads e-mails or document content, or reaches an external service.

JSON definition

Exact tools/list entry
{
  "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
  }
}