@sqlrooms/documents / CreateListBlockDocumentBlocksToolOptions

Type Alias: CreateListBlockDocumentBlocksToolOptions

CreateListBlockDocumentBlocksToolOptions = object

Options for creating a generic block-document listing tool.

Properties

blockDocumentAdapter

blockDocumentAdapter: BlockDocumentAiAdapter

Adapter for block document operations.

---

blockDocumentId

blockDocumentId: string

ID of the block document to inspect.

---

usageHint?

optional usageHint?: string

Optional host-specific guidance appended to the tool description.

---

augmentBlockSummary?

optional augmentBlockSummary?: BlockDocumentBlockSummaryAugmenter

Optional host-specific summary metadata, such as runtime issues.