Détail d'un dossier

Nom de l'outilget_dossier
Lecture seuleIdempotent

Description

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

Renvoie le détail d'un dossier (chantier) Oxygenius : statut, type de chantier, gestionnaire, adresse du chantier, étape en cours et étapes de la procédure, tiers liés avec leur rôle et leurs coordonnées, et nombre de devis, factures et notes de crédit.

Accès requis

Paramètres

NomTypePrésenceDescription
dossierIdintegerobligatoireIdentifiant technique du dossier (champ id de search_dossiers).

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
idintegerIdentifiant technique du dossier.
referencestringpeut être nullRéférence du dossier.
indicationstringpeut être nullIntitulé court du dossier (indication).
statusstringpeut être nullLibellé du statut du dossier.
siteTypestringpeut être nullType de chantier.
isActivebooleanFaux si le dossier est désactivé.
externalReference1stringpeut être nullRéférence externe 1 (référence client).
externalReference2stringpeut être nullRéférence externe 2.
managerstringpeut être nullNom du gestionnaire du dossier.
creationDatestring (date)peut être nullDate de création du dossier (AAAA-MM-JJ).
siteAddressstringpeut être nullAdresse du chantier : celle du tiers « chantier » s'il y en a un, sinon celle du dossier.
currentStepstringpeut être nullÉtape en cours : première étape non terminée de la procédure.
stepsobject[]Étapes de la procédure, dans l'ordre.
steps[].namestringpeut être nullNom de l'étape.
steps[].isCompletedbooleanVrai si l'étape est terminée.
steps[].completedOnstring (date)peut être nullDate de fin de l'étape (AAAA-MM-JJ), si elle est terminée.
steps[].dueDatestring (date)peut être nullÉchéance prévue de l'étape (AAAA-MM-JJ).
tiersobject[]Tiers liés au dossier, avec leur rôle (propriétaire, locataire, contact, provenance…).
tiers[].tiersIdintegerIdentifiant technique du tiers (à passer à get_tiers).
tiers[].rolestringpeut être nullRôle du tiers dans le dossier (libellé).
tiers[].namestringDénomination : société, sinon nom et prénom.
tiers[].referencestringpeut être nullRéférence du tiers.
tiers[].emailstringpeut être nullCourriel principal.
tiers[].phonestringpeut être nullTéléphone principal.
tiers[].isInvoiceReceiverbooleanVrai si le tiers reçoit les factures du dossier.
tiers[].isSiteTiersbooleanVrai si l'adresse du tiers est l'adresse du chantier.
estimateCountintegerpeut être nullNombre de devis du dossier (null sans accès aux devis). Détail : search_estimates avec dossierId.
invoiceCountintegerpeut être nullNombre de factures du dossier (null sans accès aux factures). Détail : search_invoices avec dossierId.
creditNoteCountintegerpeut être nullNombre de notes de crédit du dossier (null sans accès). Détail : search_credit_notes avec dossierId.

Annotations MCP

AnnotationValeurSignification
titleDétail 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": "get_dossier",
  "title": "Détail d'un dossier",
  "description": "Renvoie le détail d'un dossier (chantier) Oxygenius : statut, type de chantier, gestionnaire, adresse du chantier, étape en cours et étapes de la procédure, tiers liés avec leur rôle et leurs coordonnées, et nombre de devis, factures et notes de crédit.",
  "inputSchema": {
    "type": "object",
    "properties": {
      "dossierId": {
        "description": "Identifiant technique du dossier (champ id de search_dossiers).",
        "type": "integer"
      }
    },
    "required": [
      "dossierId"
    ]
  },
  "outputSchema": {
    "type": "object",
    "properties": {
      "id": {
        "description": "Identifiant technique du dossier.",
        "type": "integer"
      },
      "reference": {
        "description": "Référence du dossier.",
        "type": [
          "string",
          "null"
        ]
      },
      "indication": {
        "description": "Intitulé court du dossier (indication).",
        "type": [
          "string",
          "null"
        ]
      },
      "status": {
        "description": "Libellé du statut du dossier.",
        "type": [
          "string",
          "null"
        ]
      },
      "siteType": {
        "description": "Type de chantier.",
        "type": [
          "string",
          "null"
        ]
      },
      "isActive": {
        "description": "Faux si le dossier est désactivé.",
        "type": "boolean"
      },
      "externalReference1": {
        "description": "Référence externe 1 (référence client).",
        "type": [
          "string",
          "null"
        ]
      },
      "externalReference2": {
        "description": "Référence externe 2.",
        "type": [
          "string",
          "null"
        ]
      },
      "manager": {
        "description": "Nom du gestionnaire du dossier.",
        "type": [
          "string",
          "null"
        ]
      },
      "creationDate": {
        "description": "Date de création du dossier (AAAA-MM-JJ).",
        "type": [
          "string",
          "null"
        ],
        "format": "date"
      },
      "siteAddress": {
        "description": "Adresse du chantier : celle du tiers « chantier » s'il y en a un, sinon celle du dossier.",
        "type": [
          "string",
          "null"
        ]
      },
      "currentStep": {
        "description": "Étape en cours : première étape non terminée de la procédure.",
        "type": [
          "string",
          "null"
        ]
      },
      "steps": {
        "description": "Étapes de la procédure, dans l'ordre.",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "description": "Nom de l'étape.",
              "type": [
                "string",
                "null"
              ]
            },
            "isCompleted": {
              "description": "Vrai si l'étape est terminée.",
              "type": "boolean"
            },
            "completedOn": {
              "description": "Date de fin de l'étape (AAAA-MM-JJ), si elle est terminée.",
              "type": [
                "string",
                "null"
              ],
              "format": "date"
            },
            "dueDate": {
              "description": "Échéance prévue de l'étape (AAAA-MM-JJ).",
              "type": [
                "string",
                "null"
              ],
              "format": "date"
            }
          },
          "required": [
            "isCompleted"
          ]
        }
      },
      "tiers": {
        "description": "Tiers liés au dossier, avec leur rôle (propriétaire, locataire, contact, provenance…).",
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "tiersId": {
              "description": "Identifiant technique du tiers (à passer à get_tiers).",
              "type": "integer"
            },
            "role": {
              "description": "Rôle du tiers dans le dossier (libellé).",
              "type": [
                "string",
                "null"
              ]
            },
            "name": {
              "description": "Dénomination : société, sinon nom et prénom.",
              "type": "string"
            },
            "reference": {
              "description": "Référence du tiers.",
              "type": [
                "string",
                "null"
              ]
            },
            "email": {
              "description": "Courriel principal.",
              "type": [
                "string",
                "null"
              ]
            },
            "phone": {
              "description": "Téléphone principal.",
              "type": [
                "string",
                "null"
              ]
            },
            "isInvoiceReceiver": {
              "description": "Vrai si le tiers reçoit les factures du dossier.",
              "type": "boolean"
            },
            "isSiteTiers": {
              "description": "Vrai si l'adresse du tiers est l'adresse du chantier.",
              "type": "boolean"
            }
          },
          "required": [
            "tiersId",
            "name",
            "isInvoiceReceiver",
            "isSiteTiers"
          ]
        }
      },
      "estimateCount": {
        "description": "Nombre de devis du dossier (null sans accès aux devis). Détail : search_estimates avec dossierId.",
        "type": [
          "integer",
          "null"
        ]
      },
      "invoiceCount": {
        "description": "Nombre de factures du dossier (null sans accès aux factures). Détail : search_invoices avec dossierId.",
        "type": [
          "integer",
          "null"
        ]
      },
      "creditNoteCount": {
        "description": "Nombre de notes de crédit du dossier (null sans accès). Détail : search_credit_notes avec dossierId.",
        "type": [
          "integer",
          "null"
        ]
      }
    },
    "required": [
      "id",
      "isActive"
    ]
  },
  "annotations": {
    "title": "Détail d'un dossier",
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false,
    "readOnlyHint": true
  }
}