Skip to main content

Catalog Get Tool

catalog_get is a native tool that can read one public catalog artifact projection.

When To Use It​

Use catalog_get when a bot or workflow needs this capability inside the current workspace. Prefer this tool over ad hoc text handling when the task depends on workspace artifacts, blobs, links, events, channels, forms, media, or operation state.

Inputs And Outputs​

  • Tool name: catalog_get.
  • Input contract: CatalogGetArgs with fields catalog_ref.
  • Output contract: ArtifactView.

The caller should provide exact workspace, artifact, blob, channel, or operation references from the current context whenever the contract requires them.

Example Task​

A user can ask the selected workspace bot to run this kind of tool-backed work when the needed source context is visible or named. The bot should return a concise result and point to any artifact, blob, event, message, or operation output that was created or inspected.

Limits And Review​

  • Confirm the bot has access to the workspace and relevant artifacts.
  • Check required references before retrying a failed call.
  • Keep results bounded enough for channel delivery and operation review.
  • Treat returned context as a guide to source artifacts, not a replacement for source review.

Media To Add​

  • Table: example catalog_get input fields, output fields, and review action. It helps developers and admins understand the contract without reading raw schemas. Source: a sample operation that uses this tool.