Documents d'un dossier

Nom de l'outillist_dossier_documents
Lecture seuleIdempotent

Description

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

Liste les documents (fichiers) d'un dossier Oxygenius, comme son onglet Documents : documents importés, devis, factures et rapports générés, photos, pièces jointes classées… du plus récent au plus ancien. Seuls les types de document permis aux rôles de l'utilisateur sont renvoyés. read_document en lit le contenu (PDF, texte), get_document_download_link donne un lien de téléchargement.

Accès requis

Paramètres

NomTypePrésenceDescription
dossierIdintegerobligatoireIdentifiant du dossier (champ id de search_dossiers).
querystringfacultatifMots-clés cherchés dans le nom, la description et le type du document.
typestringfacultatifFragment du type de document (ex. devis, facture, photo, plan).
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 du document (à passer à read_document ou get_document_download_link).
items[].namestringpeut être nullNom du fichier.
items[].typestringpeut être nullType de document (devis, facture, photo, plan…).
items[].contentTypestringpeut être nullType MIME.
items[].sizeBytesintegerTaille en octets.
items[].descriptionstringpeut être nullDescription saisie.
items[].createdAtstring (date-time)peut être nullDate d'ajout, en heure locale belge.
items[].createdBystringpeut être nullPersonne qui a ajouté ou généré le document.
items[].isAvailablebooleanFaux pour un ancien fichier pas encore migré vers le stockage en ligne : ni lien ni contenu ne sont alors disponibles.
items[].isReadablebooleanVrai si read_document sait en lire le contenu (PDF ou texte).

Annotations MCP

AnnotationValeurSignification
titleDocuments d'un dossierNom 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": "list_dossier_documents",
  "title": "Documents d'un dossier",
  "description": "Liste les documents (fichiers) d'un dossier Oxygenius, comme son onglet Documents : documents importés, devis, factures et rapports générés, photos, pièces jointes classées… du plus récent au plus ancien. Seuls les types de document permis aux rôles de l'utilisateur sont renvoyés. read_document en lit le contenu (PDF, texte), get_document_download_link donne un lien de téléchargement.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "dossierId": {
        "description": "Identifiant du dossier (champ id de search_dossiers).",
        "type": "integer"
      },
      "query": {
        "description": "Mots-clés cherchés dans le nom, la description et le type du document.",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "type": {
        "description": "Fragment du type de document (ex. devis, facture, photo, plan).",
        "type": [
          "string",
          "null"
        ],
        "default": null
      },
      "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
      }
    },
    "required": [
      "dossierId"
    ]
  },
  "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 du document (à passer à read_document ou get_document_download_link).",
              "type": "integer"
            },
            "name": {
              "description": "Nom du fichier.",
              "type": [
                "string",
                "null"
              ]
            },
            "type": {
              "description": "Type de document (devis, facture, photo, plan…).",
              "type": [
                "string",
                "null"
              ]
            },
            "contentType": {
              "description": "Type MIME.",
              "type": [
                "string",
                "null"
              ]
            },
            "sizeBytes": {
              "description": "Taille en octets.",
              "type": "integer"
            },
            "description": {
              "description": "Description saisie.",
              "type": [
                "string",
                "null"
              ]
            },
            "createdAt": {
              "description": "Date d'ajout, en heure locale belge.",
              "type": [
                "string",
                "null"
              ],
              "format": "date-time"
            },
            "createdBy": {
              "description": "Personne qui a ajouté ou généré le document.",
              "type": [
                "string",
                "null"
              ]
            },
            "isAvailable": {
              "description": "Faux pour un ancien fichier pas encore migré vers le stockage en ligne : ni lien ni contenu ne sont alors disponibles.",
              "type": "boolean"
            },
            "isReadable": {
              "description": "Vrai si read_document sait en lire le contenu (PDF ou texte).",
              "type": "boolean"
            }
          },
          "required": [
            "id",
            "sizeBytes",
            "isAvailable",
            "isReadable"
          ]
        }
      }
    },
    "required": [
      "totalCount",
      "offset",
      "limit",
      "hasMore",
      "items"
    ]
  },
  "annotations": {
    "title": "Documents d'un dossier",
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": true
  }
}