Skip to main content

Dify Plugin SDK

Project description

Dify Plugin SDK

A Python SDK for building plugins for Dify.

Here is a short introduction to Dify Plugin: https://docs.dify.ai/plugins/introduction

Development

This repository uses just as its command runner. Install it with your preferred package manager, or with uv:

uv tool install rust-just

Common development commands:

just dev      # Sync default dev dependencies
just check    # Check lockfile, formatting, and linting
just test     # Run all tests
just build    # Build source and wheel distributions

LLM Polling Support

SDK 0.9.0 adds support for polling-based LLM invocation. A model can now declare the polling feature and implement polling methods, allowing plugins to submit long-running provider jobs and return later checks through a short request/response flow.

Polling results use three states:

  • running returns plugin-owned state for the next check.
  • succeeded returns the final LLM result.
  • failed returns a terminal error.

Version Management

This SDK follows Semantic Versioning (a.b.c):

  • a: Major version - Indicates significant architectural changes or incompatible API modifications
  • b: Minor version - Indicates new feature additions while maintaining backward compatibility
  • c: Patch version - Indicates backward-compatible bug fixes

For SDK Users

When depending on this SDK, it's recommended to specify version constraints that:

  • Allow patch and minor updates for bug fixes and new features
  • Prevent major version updates to avoid breaking changes

Example in your project's dependency management:

dify_plugin >= 0.8

Manifest Version Reference

For the manifest specification, we've introduced two versioning fields:

  • meta.version - The version of the manifest specification, designed for backward compatibility. When installing an older plugin to a newer Dify, it's difficult to ensure breaking changes never occur, but at least Dify can detect them through this field. Once an unsupported version is detected, Dify will only use the supported parts of the plugin.
  • meta.minimum_dify_version - The minimum version of Dify, designed for forward compatibility. When installing a newer plugin to an older Dify, many new features may not be available, but showing the minimum Dify version helps users understand how to upgrade.

Meta.Version Reference

Manifest Version Description
0.0.2 As ToolProviderType now supports mcp, an elder implementation is going to broken when user selected a mcp tool in Dify, so we bump it to 0.0.2 to ensure Dify knows that mcp is disabled if meta.version under 0.0.2.
0.0.1 Initial release

Meta.MinimumDifyVersion Reference

Minimum Dify Version SDK Version Description
1.2.0 0.2.0 Support fetching application info
1.4.0 0.0.1-beta.49 Support LLM multimodal output
1.4.0 0.3.1 Support OAuth functionality for plugins
1.5.1 0.4.0 Support dynamic-select parameter type
1.5.1 0.4.0 Support LLM structured output
1.6.0 0.4.1 Support dark-icon field in manifest
1.7.0 0.4.2 Support OAuth functionality for plugins
1.8.1 0.4.4 Support filename in MultiModalPromptMessageContent
1.9.0 0.5.0 Support Datasource functionality for plugins
1.10.0 0.6.0 Support Trigger functionality for plugins
1.11.0 0.7.0 Support Multimodal Reranking / Embeddings
1.14.0 0.8.1 Dependency and project structure cleanup
1.14.2 0.9.0 Support polling-based LLM plugin invocations

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dify_plugin-0.9.1.tar.gz (318.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dify_plugin-0.9.1-py3-none-any.whl (377.0 kB view details)

Uploaded Python 3

File details

Details for the file dify_plugin-0.9.1.tar.gz.

File metadata

  • Download URL: dify_plugin-0.9.1.tar.gz
  • Upload date:
  • Size: 318.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for dify_plugin-0.9.1.tar.gz
Algorithm Hash digest
SHA256 81f96f9a78ca76b22361eb40c54935bb6cf9b3d0d2be44828d63e0a25e3cb0e8
MD5 1a9fb041c0866ec06e6d52ef6983e11c
BLAKE2b-256 ba9b5d78d22aa32942f9d5375f2b0d913b3e529f8456cb91aaf04fa50638b8d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for dify_plugin-0.9.1.tar.gz:

Publisher: release.yml on langgenius/dify-plugin-sdks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dify_plugin-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: dify_plugin-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 377.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for dify_plugin-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c45ed4f06ccd9375382c728ebd6b7394da854273f59666c25c0d7b914a0dbf0
MD5 b7a50f9ea3e62fc131a596a77a9ec615
BLAKE2b-256 66f09538bfce0df4e816f28a91c38e762fcf45fc10f4a0751e3bb0f83bcf4f11

See more details on using hashes here.

Provenance

The following attestation bundles were made for dify_plugin-0.9.1-py3-none-any.whl:

Publisher: release.yml on langgenius/dify-plugin-sdks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page