Documents d'un dossier

Tool namelist_dossier_documents
Read-onlyIdempotent

Lists a project's files (imported documents, generated estimates and invoices, photos, filed attachments), limited to the document types the user's roles allow.

Description

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

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.

Required access

Parameters

NameTypePresenceDescription
dossierIdintegerrequiredIdentifiant du dossier (champ id de search_dossiers).
querystringoptionalMots-clés cherchés dans le nom, la description et le type du document.
typestringoptionalFragment du type de document (ex. devis, facture, photo, plan).
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 du document (à passer à read_document ou get_document_download_link).
items[].namestringnullableNom du fichier.
items[].typestringnullableType de document (devis, facture, photo, plan…).
items[].contentTypestringnullableType MIME.
items[].sizeBytesintegerTaille en octets.
items[].descriptionstringnullableDescription saisie.
items[].createdAtstring (date-time)nullableDate d'ajout, en heure locale belge.
items[].createdBystringnullablePersonne 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).

MCP annotations

AnnotationValueMeaning
titleDocuments d'un dossierHuman-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": "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
  }
}