Rechercher des articles
Tool name
search_itemsRead-onlyIdempotent
Lists or searches catalogue items and assemblies alphabetically, with their sale price and, with the Stock module, the quantity in stock.
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.
Required access
- Permission:
item-job.list.view - Without them, the tool is not listed by
tools/listand calling it is refused.
Parameters
| Name | Type | Presence | Description |
|---|---|---|---|
query | string | optional | Mots-clés : désignation, références interne et externe, code-barres, description, marque. |
kind | string | optional | all (défaut), article (fournitures) ou job (ouvrages). |
category | string | optional | Fragment du nom de la catégorie ou de la famille d'articles. |
availability | string | optional | Module Stock : all (défaut), in-stock (en stock), out-of-stock (rupture) ou below-minimum (sous le stock minimum). |
includeInactive | boolean | optional | Inclure les articles désactivés (faux par défaut). |
limit | integer | optional | Nombre de résultats souhaités (10 par défaut, plafonné par le serveur). |
offset | integer | optional | Nombre de résultats à sauter pour la pagination (0 par défaut). |
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
| Name | Type | Presence | Description |
|---|---|---|---|
totalCount | integer | Nombre total d'éléments correspondant aux critères. | |
offset | integer | Position du premier élément de la page. | |
limit | integer | Taille de page appliquée (le serveur plafonne la valeur demandée). | |
hasMore | boolean | Vrai s'il reste des éléments : rappeler l'outil avec offset = offset + limit. | |
items | object[] | Éléments de la page. | |
items[].id | integer | Identifiant de l'article (à passer à get_item ou get_item_stock). | |
items[].kind | string | article (fourniture stockable), job (ouvrage composé d'articles) ou other. | |
items[].name | string | nullable | Désignation. |
items[].internalReference | string | nullable | Référence interne. |
items[].externalReference | string | nullable | Référence externe (fabricant, fournisseur). |
items[].category | string | nullable | Catégorie (matériau, main d'œuvre…). |
items[].family | string | nullable | Famille d'articles. |
items[].brand | string | nullable | Marque. |
items[].unit | string | nullable | Unité de vente. |
items[].salesPrice | number | nullable | Prix de vente unitaire hors TVA, en euros. |
items[].vatRate | number | nullable | Taux de TVA de vente en pourcents. |
items[].isActive | boolean | Faux pour un article désactivé. | |
items[].stockQuantity | number | nullable | Quantité totale en stock, tous emplacements (articles ; absent sans le module Stock). |
MCP annotations
| Annotation | Value | Meaning |
|---|---|---|
title | Rechercher des articles | Human-readable name shown by the MCP client. |
readOnlyHint | yes | The tool changes nothing. |
destructiveHint | no | The tool may change or delete existing data, or trigger an irreversible action. |
idempotentHint | yes | Calling it again with the same arguments has no further effect. |
openWorldHint | no | The 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
}
}