Skip to main content

AvailablePluginDto

Available plugin (not yet enabled by user)

capabilities objectrequired

Plugin capabilities

readSyncbooleanrequired

Can sync reading progress

userRecommendationProviderbooleanrequired

Can provide recommendations

wantsDetailedProgressbooleanrequired

Consumes the per-book reading-progress breakdown (readBooks); when set, the host attaches per-book volume/chapter/page detail to sync entries.

wantsFullMetadatabooleanrequired

Consumes enriched series data (tags/genres/bibliographic block, and admin-permitted custom metadata) on the entries the host sends.

descriptionstring | nullnullable

Plugin description

displayNamestringrequired

Plugin display name

namestringrequired

Plugin name

oauthConfiguredbooleanrequired

Whether the admin has configured OAuth credentials (client_id set)

pluginIdstring<uuid>required

Plugin definition ID

requiresOauthbooleanrequired

Whether this plugin requires OAuth authentication

userSetupInstructionsstring | nullnullable

User-facing setup instructions for the plugin

AvailablePluginDto
{
  "capabilities": {
    "readSync": true,
    "userRecommendationProvider": true,
    "wantsDetailedProgress": true,
    "wantsFullMetadata": true
  },
  "description": "string",
  "displayName": "string",
  "name": "string",
  "oauthConfigured": true,
  "pluginId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "requiresOauth": true,
  "userSetupInstructions": "string"
}