Référence MCP

list_documents

Lister les documents

Référence générée depuis le contrat versionné · Version Markdown

Rôle#

Métadonnées des documents accessibles de l’organisation, filtrables par nom, type, porteur, auteur, dates UTC et partage. Exige documents:read et le scope de lecture de chaque porteur. Avec object et id seuls, conserve la réponse historique de la fiche ; sinon, pagination par cursor et limit. get_document_url donne le contenu par lien signé temporaire.

Accès#

Scope principal : documents:read. Le scope ne remplace pas les gardes de visibilité, d'organisation, de module ni les scopes complémentaires des gestes composés.

Catalogue complet · Approbations

Paramètres#

Le schéma ci-dessous est produit par la fonction qui enregistre les outils, y compris idempotency_key lorsqu'elle s'applique. Consultez les objets imbriqués dans le schéma complet.

Champ	Type	Obligatoire	Description
`cursor`	string	Non
`limit`	integer	Non
`object`	string	Non	Valeurs : company, contact, quote, contract, request, invoice, order, product
`id`	string	Non
`type`	string	Non
`authorId`	string	Non
`q`	string	Non
`from`	string	Non
`to`	string	Non
`shared`	string	Non	Valeurs : true, false

Schéma JSON complet des paramètres

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "minLength": 1
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "object": {
      "type": "string",
      "enum": [
        "company",
        "contact",
        "quote",
        "contract",
        "request",
        "invoice",
        "order",
        "product"
      ]
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "authorId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "q": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "from": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
    },
    "to": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
    },
    "shared": {
      "type": "string",
      "enum": [
        "true",
        "false"
      ]
    }
  },
  "additionalProperties": false
}