search_disclosure_text

Search disclosure text

Find the pages of a disclosure package version that bear on a question: keyword matching over the package text, plus meaning-based matches when Ohvii's search index is available. Returns page references with a short excerpt inside untrusted delimiters. Read the pages you rely on with get_disclosure_pages (documentId and startPageIndex) and answer the buyer yourself, naming the document and page; excerpts are the seller's documents, not Ohvii's conclusions. Try other wording when a search finds nothing; no match is not proof the package says nothing.

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 validated JSON in a text content block. No output schema is advertised on the wire for this text-result tool.

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
`documentId`string	No	Search only this document. Pattern validation applies; see the raw schema.
`limit`integer	No	Pages to return, 1 to 20 (default 8). Minimum: 1. Maximum: 20.
`packageId`string	Yes	Pattern validation applies; see the raw schema.
`query`string	Yes	Words to look for, such as roof leak, foundation crack, HOA special assessment, permit. Minimum characters: 2. Maximum characters: 300.
`versionId`string	No	Pattern validation applies; see the raw schema.
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field Required Meaning and constraints

modestring

Yes

Allowed: "hybrid", "keyword".

packageIdstring

Yes

Pattern validation applies; see the raw schema.

resultsarray<object>

Yes

Maximum items: 20.

results: nested contract

Array item contract

Extra fields are not allowed.

Field	Required	Meaning and constraints
`documentId`string	Yes	Pattern validation applies; see the raw schema.
`documentKind`string	Yes	Minimum characters: 1. Maximum characters: 80.
`documentLabel`string \| null	Yes	Must match at least one alternative.
documentLabel: nested contract Alternative 1: string Maximum characters: 6000. Alternative 2: null
`excerpt`string \| null	Yes	Must match at least one alternative.
excerpt: nested contract Alternative 1: string Maximum characters: 6000. Alternative 2: null
`matchedTerms`array<string>	Yes	Maximum items: 20.
matchedTerms: nested contract Array item contract Maximum characters: 60.
`pageIndex`integer	Yes	Minimum: 0. Maximum: 9007199254740991.
`pageNumber`integer	Yes	Maximum: 9007199254740991. Greater than: 0.
`ref`string	Yes	Maximum characters: 20.
`score`number	Yes	Minimum: 0.
`via`string	Yes	Allowed: "both", "keyword", "semantic".

schemaVersionstring

Yes

Must be "1".

versionIdstring

Yes

Pattern validation applies; see the raw schema.

workspaceIdstring

Yes

Pattern validation applies; see the raw schema.

Raw input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "documentId": {
      "description": "Search only this document.",
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "limit": {
      "description": "Pages to return, 1 to 20 (default 8).",
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    },
    "packageId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "query": {
      "type": "string",
      "minLength": 2,
      "maxLength": 300,
      "description": "Words to look for, such as roof leak, foundation crack, HOA special assessment, permit."
    },
    "versionId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "packageId",
    "query",
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "mode": {
      "type": "string",
      "enum": [
        "hybrid",
        "keyword"
      ]
    },
    "packageId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "results": {
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "documentId": {
            "type": "string",
            "pattern": "^[A-Za-z0-9_-]{1,200}$"
          },
          "documentKind": {
            "type": "string",
            "minLength": 1,
            "maxLength": 80
          },
          "documentLabel": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 6000
              },
              {
                "type": "null"
              }
            ]
          },
          "excerpt": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 6000
              },
              {
                "type": "null"
              }
            ]
          },
          "matchedTerms": {
            "maxItems": 20,
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 60
            }
          },
          "pageIndex": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "pageNumber": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          },
          "ref": {
            "type": "string",
            "maxLength": 20
          },
          "score": {
            "type": "number",
            "minimum": 0
          },
          "via": {
            "type": "string",
            "enum": [
              "both",
              "keyword",
              "semantic"
            ]
          }
        },
        "required": [
          "documentId",
          "documentKind",
          "documentLabel",
          "excerpt",
          "matchedTerms",
          "pageIndex",
          "pageNumber",
          "ref",
          "score",
          "via"
        ],
        "additionalProperties": false
      }
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "versionId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "mode",
    "packageId",
    "results",
    "schemaVersion",
    "versionId",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

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

Reference 00e5441a095c7e20. Download the full catalog.