Détail d'un dossier
Nom de l'outil
get_dossierLecture seuleIdempotent
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.
Accès requis
- Permission :
dossier.details.view - Sans ces conditions, l'outil n'apparaît pas dans
tools/listet son appel est refusé.
Paramètres
| Nom | Type | Présence | Description |
|---|---|---|---|
dossierId | integer | obligatoire | Identifiant 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
| Nom | Type | Présence | Description |
|---|---|---|---|
id | integer | Identifiant technique du dossier. | |
reference | string | peut être null | Référence du dossier. |
indication | string | peut être null | Intitulé court du dossier (indication). |
status | string | peut être null | Libellé du statut du dossier. |
siteType | string | peut être null | Type de chantier. |
isActive | boolean | Faux si le dossier est désactivé. | |
externalReference1 | string | peut être null | Référence externe 1 (référence client). |
externalReference2 | string | peut être null | Référence externe 2. |
manager | string | peut être null | Nom du gestionnaire du dossier. |
creationDate | string (date) | peut être null | Date de création du dossier (AAAA-MM-JJ). |
siteAddress | string | peut être null | Adresse du chantier : celle du tiers « chantier » s'il y en a un, sinon celle du dossier. |
currentStep | string | peut être null | Étape en cours : première étape non terminée de la procédure. |
steps | object[] | Étapes de la procédure, dans l'ordre. | |
steps[].name | string | peut être null | Nom de l'étape. |
steps[].isCompleted | boolean | Vrai si l'étape est terminée. | |
steps[].completedOn | string (date) | peut être null | Date de fin de l'étape (AAAA-MM-JJ), si elle est terminée. |
steps[].dueDate | string (date) | peut être null | Échéance prévue de l'étape (AAAA-MM-JJ). |
tiers | object[] | Tiers liés au dossier, avec leur rôle (propriétaire, locataire, contact, provenance…). | |
tiers[].tiersId | integer | Identifiant technique du tiers (à passer à get_tiers). | |
tiers[].role | string | peut être null | Rôle du tiers dans le dossier (libellé). |
tiers[].name | string | Dénomination : société, sinon nom et prénom. | |
tiers[].reference | string | peut être null | Référence du tiers. |
tiers[].email | string | peut être null | Courriel principal. |
tiers[].phone | string | peut être null | Téléphone principal. |
tiers[].isInvoiceReceiver | boolean | Vrai si le tiers reçoit les factures du dossier. | |
tiers[].isSiteTiers | boolean | Vrai si l'adresse du tiers est l'adresse du chantier. | |
estimateCount | integer | peut être null | Nombre de devis du dossier (null sans accès aux devis). Détail : search_estimates avec dossierId. |
invoiceCount | integer | peut être null | Nombre de factures du dossier (null sans accès aux factures). Détail : search_invoices avec dossierId. |
creditNoteCount | integer | peut être null | Nombre de notes de crédit du dossier (null sans accès). Détail : search_credit_notes avec dossierId. |
Annotations MCP
| Annotation | Valeur | Signification |
|---|---|---|
title | Détail d'un dossier | Nom lisible affiché par le client MCP. |
readOnlyHint | oui | L'outil ne modifie rien. |
destructiveHint | non | L'outil peut modifier ou supprimer des données existantes, ou déclencher une action irréversible. |
idempotentHint | oui | Rappeler l'outil avec les mêmes arguments n'a pas d'effet supplémentaire. |
openWorldHint | non | L'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
}
}