Détail d'un dossier

Tool nameget_dossier
Read-onlyIdempotent

Returns a project: status, site type, manager, site address, current step and procedure steps, linked third parties and counts of estimates, invoices and credit notes.

Description

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

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.

Required access

Parameters

NameTypePresenceDescription
dossierIdintegerrequiredIdentifiant technique du dossier (champ id de search_dossiers).

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
idintegerIdentifiant technique du dossier.
referencestringnullableRéférence du dossier.
indicationstringnullableIntitulé court du dossier (indication).
statusstringnullableLibellé du statut du dossier.
siteTypestringnullableType de chantier.
isActivebooleanFaux si le dossier est désactivé.
externalReference1stringnullableRéférence externe 1 (référence client).
externalReference2stringnullableRéférence externe 2.
managerstringnullableNom du gestionnaire du dossier.
creationDatestring (date)nullableDate de création du dossier (AAAA-MM-JJ).
siteAddressstringnullableAdresse du chantier : celle du tiers « chantier » s'il y en a un, sinon celle du dossier.
currentStepstringnullableÉtape en cours : première étape non terminée de la procédure.
stepsobject[]Étapes de la procédure, dans l'ordre.
steps[].namestringnullableNom de l'étape.
steps[].isCompletedbooleanVrai si l'étape est terminée.
steps[].completedOnstring (date)nullableDate de fin de l'étape (AAAA-MM-JJ), si elle est terminée.
steps[].dueDatestring (date)nullableÉ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[].rolestringnullableRôle du tiers dans le dossier (libellé).
tiers[].namestringDénomination : société, sinon nom et prénom.
tiers[].referencestringnullableRéférence du tiers.
tiers[].emailstringnullableCourriel principal.
tiers[].phonestringnullableTé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.
estimateCountintegernullableNombre de devis du dossier (null sans accès aux devis). Détail : search_estimates avec dossierId.
invoiceCountintegernullableNombre de factures du dossier (null sans accès aux factures). Détail : search_invoices avec dossierId.
creditNoteCountintegernullableNombre de notes de crédit du dossier (null sans accès). Détail : search_credit_notes avec dossierId.

MCP annotations

AnnotationValueMeaning
titleDétail 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": "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
  }
}