Plug Database icon

Plug Database

Run Plug Database commands over REST or Socket.

User Access → List Agent Catalog

AI-generated

Summary

List agent catalog entries from Plug's User Access resource, optionally filtered by agent status and search text, with support for pagination and metadata inclusion.

Inputs

  • Include Plug Metadata — Include the __plug object containing operation and pagination metadata in the response.
  • Agent Status — Filter agents by their status: All, Active, or Inactive.
  • Search — Optional search text to filter the catalog entries.
  • Return All — Whether to fetch all pages from the Plug catalog before returning results.
  • Page — Specify which catalog page to request when Return All is false.
  • Page Size — Number of entries per catalog page to request when Return All is false.

Output shape

a list of agent catalog items, each optionally including associated metadata depending on the Include Plug Metadata input

Supports paginated results; when Return All is false, a single page of size Page Size is returned. When true, all pages are aggregated and returned. The __plug metadata property is included only if Include Plug Metadata is true.

Examples

Example 1: Retrieve all active agents with metadata included

Set Agent Status to Active, Include Plug Metadata true, Return All true.

Example 2: Search inactive agents and fetch first page of 25 without metadata

Set Agent Status to Inactive, Search to desired text, Page 1, Page Size 25, Include Plug Metadata false, Return All false.

Links

Discussion