list_disclosure_packages

List disclosure packages

List the seller disclosure packages on a transaction with their processing status, document kinds, finding counts by tier, who reads each one (analysis: buyer_ai means you read it with get_disclosure_pages and record findings with record_disclosure_findings; awaiting_buyer_ai means that reading is not finished), review state, signature readiness, and the handoff links the buyer's own package card offers: the review room, and its signing flow when the package is ready to sign. Disclosure signing happens on Ohvii through that link. Package titles are document-derived and arrive inside untrusted delimiters. No package on a saved home means nothing has come from the listing side yet: offer the listing_outreach email (create_transaction_product_draft) that asks the listing agent for it, never a portal's tour contact. Available when the deployment has disclosure review enabled.

Effect: Read
Required scopes: documents:read
Workflow stages: offer, transaction
Data classes: disclosures, documents
Operation cost: 1 weighted units; additional domain limits may apply.
Configurations: Standard, Buyer UI v2
Muse proposal: Read. Retrieves or computes authorized information; consult the tool contract for its scopes and result. Meta makes the final classification during review.

Buyer approval and signing controls apply in addition to the scopes above. Read error and retry guidance before implementing recovery.

Input and output contracts

Returns structured content and a JSON text content block. Live discovery may compact a large output schema; execution validates the full contract below.

Input fields

Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.

Field	Required	Meaning and constraints
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field Required Meaning and constraints

packagesarray<object>

Yes

Maximum items: 50.

packages: nested contract

Array item contract

Extra fields are not allowed.

Field Required Meaning and constraints

analysisobject

Yes

Extra fields are not allowed.

analysis: nested contract

Field	Required	Meaning and constraints
`documentsReviewed`integer	Yes	Minimum: 0. Maximum: 9007199254740991.
`documentsTotal`integer	Yes	Minimum: 0. Maximum: 9007199254740991.
`mode`string \| null	Yes	Must match at least one alternative.
mode: nested contract Alternative 1: string Allowed: "buyer_ai", "server". Alternative 2: null
`reviewedBy`string \| null	Yes	Must match at least one alternative.
reviewedBy: nested contract Alternative 1: string Maximum characters: 40. Alternative 2: null
`status`string \| null	Yes	Must match at least one alternative.
status: nested contract Alternative 1: string Allowed: "complete", "disabled", "partial", "unavailable", "awaiting_buyer_ai". Alternative 2: null
`unresolvedRejectedBatchIds`array<string>	No	Rejected finding batches still needing correction or deliberate exclusion through record_disclosure_findings. Available on a version's analysis. Maximum items: 100.
unresolvedRejectedBatchIds: nested contract Array item contract Format: uuid. Pattern validation applies; see the raw schema.

createdAtstring | null

Yes

Must match at least one alternative.

createdAt: nested contract

Alternative 1: string

Format: date-time. Pattern validation applies; see the raw schema.

Alternative 2: null

currentVersionIdstring | null

Yes

Must match at least one alternative.

currentVersionId: nested contract

Alternative 1: string

Pattern validation applies; see the raw schema.

Alternative 2: null

documentCountinteger

Yes

Minimum: 0.

Maximum: 9007199254740991.

documentKindsarray<string>

Yes

Maximum items: 50.

documentKinds: nested contract

Array item contract

Minimum characters: 1. Maximum characters: 80.

findingCountsobject

Yes

Extra fields are not allowed.

findingCounts: nested contract

Field Required Meaning and constraints

follow_upinteger

Yes

Minimum: 0.

Maximum: 9007199254740991.

referenceinteger

Yes

Minimum: 0.

Maximum: 9007199254740991.

review_firstinteger

Yes

Minimum: 0.

Maximum: 9007199254740991.

handoffobject

Yes

Extra fields are not allowed.

handoff: nested contract

Field	Required	Meaning and constraints
`reviewUrl`string \| null	Yes	Must match at least one alternative.
reviewUrl: nested contract Alternative 1: string Format: uri. Alternative 2: null
`signing`string	Yes	Allowed: "not_ready", "nothing_to_sign", "ready", "in_progress", "awaiting_co_buyer", "complete".
`signingUrl`string \| null	Yes	Must match at least one alternative.
signingUrl: nested contract Alternative 1: string Format: uri. Alternative 2: null

idstring

Yes

Pattern validation applies; see the raw schema.

latestVersionNumberinteger

Yes

Minimum: 0.

Maximum: 9007199254740991.

needsBoundaryReviewboolean Yes No additional description in the contract.

reviewedAtstring | null

Yes

Must match at least one alternative.

reviewedAt: nested contract

Alternative 1: string

Format: date-time. Pattern validation applies; see the raw schema.

Alternative 2: null

signatureReadinessstring

Yes

Allowed: "not_analyzed", "none_detected", "ready", "confirmation_required", "manual_placement_required", "boundary_review_required", "stale", "completed".

signingSessionStatusstring | null

Yes

Must match at least one alternative.

signingSessionStatus: nested contract

Alternative 1: string

Allowed: "in_progress", "awaiting_co_buyer", "completed", "stale".

Alternative 2: null

sourceChannelstring

Yes

Allowed: "buyer_upload", "inbound_email".

sourceReceivedAtstring | null

Yes

Must match at least one alternative.

sourceReceivedAt: nested contract

Alternative 1: string

Format: date-time. Pattern validation applies; see the raw schema.

Alternative 2: null

statusstring

Yes

Allowed: "awaiting_upload", "queued", "validating", "normalizing", "extracting", "analyzing", "ready", "ready_with_warnings", "failed".

titlestring | null

Yes

Must match at least one alternative.

title: nested contract

Alternative 1: string

Maximum characters: 6000.

Alternative 2: null

updatedAtstring | null

Yes

Must match at least one alternative.

updatedAt: nested contract

Alternative 1: string

Format: date-time. Pattern validation applies; see the raw schema.

Alternative 2: null

warningCountinteger

Yes

Minimum: 0.

Maximum: 9007199254740991.

schemaVersionstring

Yes

Must be "1".

workspaceIdstring

Yes

Pattern validation applies; see the raw schema.

Raw input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "packages": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "analysis": {
            "type": "object",
            "properties": {
              "documentsReviewed": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "documentsTotal": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "mode": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "buyer_ai",
                      "server"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "reviewedBy": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 40
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "status": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "complete",
                      "disabled",
                      "partial",
                      "unavailable",
                      "awaiting_buyer_ai"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "unresolvedRejectedBatchIds": {
                "description": "Rejected finding batches still needing correction or deliberate exclusion through record_disclosure_findings. Available on a version's analysis.",
                "maxItems": 100,
                "type": "array",
                "items": {
                  "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)$"
                }
              }
            },
            "required": [
              "documentsReviewed",
              "documentsTotal",
              "mode",
              "reviewedBy",
              "status"
            ],
            "additionalProperties": false
          },
          "createdAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "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])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "currentVersionId": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^[A-Za-z0-9_-]{1,200}$"
              },
              {
                "type": "null"
              }
            ]
          },
          "documentCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "documentKinds": {
            "maxItems": 50,
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 80
            }
          },
          "findingCounts": {
            "type": "object",
            "properties": {
              "follow_up": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "reference": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "review_first": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "follow_up",
              "reference",
              "review_first"
            ],
            "additionalProperties": false
          },
          "handoff": {
            "type": "object",
            "properties": {
              "reviewUrl": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "signing": {
                "type": "string",
                "enum": [
                  "not_ready",
                  "nothing_to_sign",
                  "ready",
                  "in_progress",
                  "awaiting_co_buyer",
                  "complete"
                ]
              },
              "signingUrl": {
                "anyOf": [
                  {
                    "type": "string",
                    "format": "uri"
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "reviewUrl",
              "signing",
              "signingUrl"
            ],
            "additionalProperties": false
          },
          "id": {
            "type": "string",
            "pattern": "^[A-Za-z0-9_-]{1,200}$"
          },
          "latestVersionNumber": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "needsBoundaryReview": {
            "type": "boolean"
          },
          "reviewedAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "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])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "signatureReadiness": {
            "type": "string",
            "enum": [
              "not_analyzed",
              "none_detected",
              "ready",
              "confirmation_required",
              "manual_placement_required",
              "boundary_review_required",
              "stale",
              "completed"
            ]
          },
          "signingSessionStatus": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "in_progress",
                  "awaiting_co_buyer",
                  "completed",
                  "stale"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "sourceChannel": {
            "type": "string",
            "enum": [
              "buyer_upload",
              "inbound_email"
            ]
          },
          "sourceReceivedAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "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])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "awaiting_upload",
              "queued",
              "validating",
              "normalizing",
              "extracting",
              "analyzing",
              "ready",
              "ready_with_warnings",
              "failed"
            ]
          },
          "title": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 6000
              },
              {
                "type": "null"
              }
            ]
          },
          "updatedAt": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time",
                "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])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "warningCount": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "analysis",
          "createdAt",
          "currentVersionId",
          "documentCount",
          "documentKinds",
          "findingCounts",
          "handoff",
          "id",
          "latestVersionNumber",
          "needsBoundaryReview",
          "reviewedAt",
          "signatureReadiness",
          "signingSessionStatus",
          "sourceChannel",
          "sourceReceivedAt",
          "status",
          "title",
          "updatedAt",
          "warningCount"
        ],
        "additionalProperties": false
      }
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "packages",
    "schemaVersion",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": true
}

Reference 00e5441a095c7e20. Download the full catalog.