Skip to main content

The manifest is a YAML file that defines a plugin’s basic information: name, author, included tools and models, and more. If the file is malformed, plugin parsing and packaging fails.

For the overall plugin architecture, see Basic Concepts of Plugin Development and the Developer Cheatsheet.

Code Example#

Below is a simple manifest file; each field is explained in the Structure section that follows. For a real-world example, see the Google tool plugin manifest.

Structure#

versionversionrequired#

Plugin version.

typestringrequired#

Plugin type. Currently only plugin is supported; bundle support is planned.

authorstringrequired#

Author, defined as the organization name in the Marketplace.

labelobjectrequired#

Multilingual name.

created_atRFC3339required#

Creation time. The Marketplace requires this to be no later than the current time.

iconstringrequired#

Icon path.

resourceobject#

Resources the plugin requests.

memoryint64#

Maximum memory usage in bytes. Mainly relates to AWS Lambda resource allocation on Dify Cloud.

permissionobject#

Permissions the plugin requests.

toolobject#

Permission for reverse invocation of tools.

enabledboolean#

Whether to enable tool permissions.

modelobject#

Permission for reverse invocation of models.

enabledboolean#

Whether to enable model permissions.

llmboolean#

Whether to enable large language model permissions.

text_embeddingboolean#

Whether to enable text embedding model permissions.

rerankboolean#

Whether to enable rerank model permissions.

ttsboolean#

Whether to enable text-to-speech model permissions.

speech2textboolean#

Whether to enable speech-to-text model permissions.

moderationboolean#

Whether to enable content moderation model permissions.

nodeobject#

Permission for reverse invocation of nodes.

enabledboolean#

Whether to enable node permissions.

endpointobject#

Permission to register endpoint.

enabledboolean#

Whether to enable endpoint permissions.

appobject#

Permission for reverse invocation of app.

enabledboolean#

Whether to enable app permissions.

storageobject#

Permission to apply for persistent storage.

enabledboolean#

Whether to enable storage permissions.

sizeint64#

Maximum allowed persistent storage size, in bytes.

pluginsobjectrequired#

Lists the YAML files for the capabilities the plugin extends, as absolute paths within the plugin package. For example, to extend a model, define a file such as openai.yaml and list its path here. The file must exist at that path, or packaging fails.

Warning

The following combinations are not allowed:

  • Extending both tools and models.
  • Extending both models and Endpoints.
  • Having no extensions at all.

Currently, each extension type supports only one provider.

toolsarray[string]#

Plugin extension for Tool providers.

modelsarray[string]#

Plugin extension for Model providers.

endpointsarray[string]#

Plugin extension for Endpoints providers.

agent_strategiesarray[string]#

Plugin extension for Agent Strategy providers.

metaobjectrequired#

Metadata for the plugin.

versionversionrequired#

Manifest format version. The initial version is 0.0.1.

archarray[string]required#

Supported architectures. Currently only amd64 and arm64 are supported.

runnerobjectrequired#

Runtime configuration.

languagestringrequired#

Programming language. Currently only Python is supported.

versionstringrequired#

Language version. Currently only 3.12 is supported.

entrypointstringrequired#

Program entry point. For Python, this should be main.

privacystring#

Relative path or URL of the plugin’s privacy policy, for example "./privacy.md" or "https://your-web/privacy". Required for listing on the Dify Marketplace, where plugins must clearly state how they use user data. For details, see the Plugin Privacy Data Protection Guidelines.