Manifest

YAML schema for the plugin manifest that declares name, author, runtime, resources, permissions, and which tools/models/endpoints the plugin ships

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.

version: 0.0.1
type: "plugin"
author: "Yeuoly"
name: "neko"
label:
  en_US: "Neko"
created_at: "2024-07-12T08:03:44.658609186Z"
icon: "icon.svg"
resource:
  memory: 1048576
  permission:
    tool:
      enabled: true
    model:
      enabled: true
      llm: true
    endpoint:
      enabled: true
    app:
      enabled: true
    storage:
      enabled: true
      size: 1048576
plugins:
  endpoints:
    - "provider/neko.yaml"
meta:
  version: 0.0.1
  arch:
    - "amd64"
    - "arm64"
  runner:
    language: "python"
    version: "3.12"
    entrypoint: "main"
privacy: "./privacy.md"

Structure

version · version · required

Plugin version.

type · string · required

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

author · string · required

Author, defined as the organization name in the Marketplace.

label · object · required

Multilingual name.

created_at · RFC3339 · required

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

icon · string · required

Icon path.

resource · object

Resources the plugin requests.

memory · int64

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

permission · object

Permissions the plugin requests.

tool · object

Permission for reverse invocation of tools.

enabled · boolean

Whether to enable tool permissions.

model · object

Permission for reverse invocation of models.

enabled · boolean

Whether to enable model permissions.

llm · boolean

Whether to enable large language model permissions.

text_embedding · boolean

Whether to enable text embedding model permissions.

rerank · boolean

Whether to enable rerank model permissions.

tts · boolean

Whether to enable text-to-speech model permissions.

speech2text · boolean

Whether to enable speech-to-text model permissions.

moderation · boolean

Whether to enable content moderation model permissions.

node · object

Permission for reverse invocation of nodes.

enabled · boolean

Whether to enable node permissions.

endpoint · object

Permission to register endpoint.

enabled · boolean

Whether to enable endpoint permissions.

app · object

Permission for reverse invocation of app.

enabled · boolean

Whether to enable app permissions.

storage · object

Permission to apply for persistent storage.

enabled · boolean

Whether to enable storage permissions.

size · int64

Maximum allowed persistent storage size, in bytes.

plugins · object · required

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.

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.

tools · array[string]

Plugin extension for Tool providers.

models · array[string]

Plugin extension for Model providers.

endpoints · array[string]

Plugin extension for Endpoints providers.

agent_strategies · array[string]

Plugin extension for Agent Strategy providers.

meta · object · required

Metadata for the plugin.

version · version · required

Manifest format version. The initial version is 0.0.1.

arch · array[string] · required

Supported architectures. Currently only amd64 and arm64 are supported.

runner · object · required

Runtime configuration.

language · string · required

Programming language. Currently only Python is supported.

version · string · required

Language version. Currently only 3.12 is supported.

entrypoint · string · required

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

privacy · string

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.

---

Edit this page | Report an issue