├── requirements.txt ├── _assets ├── agent.png └── icon.svg ├── .env.example ├── main.py ├── provider ├── playwright.py └── playwright.yaml ├── manifest.yaml ├── PRIVACY.md ├── tools ├── playwright.yaml └── playwright.py ├── README.md ├── .gitignore ├── .difyignore └── GUIDE.md /requirements.txt: -------------------------------------------------------------------------------- 1 | dify_plugin~=0.0.1b76 2 | playwright~=1.51.0 -------------------------------------------------------------------------------- /_assets/agent.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hjlarry/dify-plugin-playwright/HEAD/_assets/agent.png -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | INSTALL_METHOD=remote 2 | REMOTE_INSTALL_HOST=debug.dify.ai 3 | REMOTE_INSTALL_PORT=5003 4 | REMOTE_INSTALL_KEY=********-****-****-****-************ 5 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | from dify_plugin import Plugin, DifyPluginEnv 2 | 3 | plugin = Plugin(DifyPluginEnv(MAX_REQUEST_TIMEOUT=120)) 4 | 5 | if __name__ == "__main__": 6 | plugin.run() 7 | -------------------------------------------------------------------------------- /provider/playwright.py: -------------------------------------------------------------------------------- 1 | from typing import Any 2 | 3 | from dify_plugin import ToolProvider 4 | from dify_plugin.errors.tool import ToolProviderCredentialValidationError 5 | 6 | from tools.playwright import run_playwright 7 | 8 | 9 | class PlaywrightProvider(ToolProvider): 10 | def _validate_credentials(self, credentials: dict[str, Any]) -> None: 11 | try: 12 | run_playwright(credentials.get("playwright_uri"), "") 13 | except Exception as e: 14 | raise ToolProviderCredentialValidationError(str(e)) 15 | -------------------------------------------------------------------------------- /manifest.yaml: -------------------------------------------------------------------------------- 1 | version: 0.0.1 2 | type: plugin 3 | author: hjlarry 4 | name: playwright 5 | label: 6 | en_US: playwright 7 | ja_JP: playwright 8 | zh_Hans: playwright 9 | pt_BR: playwright 10 | description: 11 | en_US: A tool can be used to automate the browser with playwright script. 12 | zh_Hans: 一个可以使用 playwright 脚本自动化浏览器的工具 13 | icon: icon.svg 14 | resource: 15 | memory: 268435456 16 | permission: {} 17 | plugins: 18 | tools: 19 | - provider/playwright.yaml 20 | meta: 21 | version: 0.0.1 22 | arch: 23 | - amd64 24 | - arm64 25 | runner: 26 | language: python 27 | version: "3.12" 28 | entrypoint: main 29 | created_at: 2025-04-02T13:57:08.013983139+08:00 30 | privacy: PRIVACY.md 31 | verified: false 32 | -------------------------------------------------------------------------------- /PRIVACY.md: -------------------------------------------------------------------------------- 1 | # Privacy Policy 2 | 3 | This tool is designed with privacy in mind and does not collect any user data. We are committed to maintaining your privacy and ensuring your data remains secure. 4 | 5 | ## Data Collection 6 | 7 | - **No Personal Information**: We do not collect, store, or process any personal information. 8 | - **No Usage Data**: We do not track or monitor how you use the tool. 9 | - **No Analytics**: We do not implement any analytics or tracking mechanisms. 10 | 11 | ## Third-Party Services 12 | 13 | This tool does not integrate with or utilize any third-party services that might collect user data. 14 | 15 | ## Changes to Privacy Policy 16 | 17 | If there are any changes to our privacy practices, we will update this document accordingly. 18 | -------------------------------------------------------------------------------- /tools/playwright.yaml: -------------------------------------------------------------------------------- 1 | identity: 2 | name: playwright 3 | author: hjlarry 4 | label: 5 | en_US: playwright 6 | zh_Hans: playwright 7 | description: 8 | human: 9 | en_US: A tool can be used to automate the browser with playwright script. 10 | zh_Hans: 一个可以使用 playwright 脚本自动化浏览器的工具 11 | llm: A tool can be used to automate the browser with playwright script. 12 | parameters: 13 | - name: script 14 | type: string 15 | required: true 16 | label: 17 | en_US: playwright script 18 | zh_Hans: playwright 脚本 19 | human_description: 20 | en_US: script send to playwright to execute 21 | zh_Hans: 发送给 playwright 执行的脚本 22 | llm_description: | 23 | Send the python script to Playwright for execution, using `;` to separate commands. Assign the final output to the variable `result`(only support string and bytes). Utilize the `browser` variable to access the browser object. Example: page = browser.new_page(); page.goto("http://www.baidu.com"); result = page.screenshot(full_page=True); 24 | form: llm 25 | extra: 26 | python: 27 | source: tools/playwright.py 28 | -------------------------------------------------------------------------------- /provider/playwright.yaml: -------------------------------------------------------------------------------- 1 | identity: 2 | author: hjlarry 3 | name: playwright 4 | label: 5 | en_US: playwright 6 | zh_Hans: playwright 7 | pt_BR: playwright 8 | description: 9 | en_US: A tool can be used to automate the browser with playwright script. 10 | zh_Hans: 一个可以使用 playwright 脚本自动化浏览器的工具 11 | icon: icon.svg 12 | tools: 13 | - tools/playwright.yaml 14 | extra: 15 | python: 16 | source: provider/playwright.py 17 | credentials_for_provider: 18 | playwright_uri: 19 | help: 20 | en_US: For example `ws://host.docker.internal:3003` 21 | zh_Hans: 例如 `ws://host.docker.internal:3003` 22 | label: 23 | en_US: Playwright URI 24 | placeholder: 25 | en_US: Please enter the Playwright URI 26 | zh_Hans: 请输入Playwright URI 27 | required: true 28 | type: secret-input 29 | uri_type: 30 | help: 31 | en_US: Choose to use ws or cdp to connect 32 | zh_Hans: 选择使用 ws 还是 cdp 连接 33 | label: 34 | en_US: URI Type 35 | zh_Hans: URI 类型 36 | required: true 37 | type: select 38 | options: 39 | - value: ws 40 | label: 41 | en_US: ws 42 | zh_Hans: ws 43 | - value: cdp 44 | label: 45 | en_US: cdp 46 | zh_Hans: cdp 47 | default: ws -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # playwright 2 | 3 | **Author:** hjlarry 4 | **Version:** 0.0.1 5 | **Type:** tool 6 | **Repo&Issue:** [https://github.com/hjlarry/dify-plugin-playwright](https://github.com/hjlarry/dify-plugin-playwright) 7 | **License:** MIT 8 | 9 | A tool can be used to automate the browser with playwright script. 10 | 11 | ## Get Started 12 | 13 | ### 1. run your playwright server 14 | 15 | The default port `3000` is already used by dify, you should change to another port. 16 | 17 | **Option 1 (Use Docker)** 18 | ``` 19 | docker run -p 3003:3000 --rm --init -it --workdir /home/pwuser --user pwuser mcr.microsoft.com/playwright:v1.51.0-noble /bin/sh -c "npx -y playwright@1.51.0 run-server --port 3000 --host 0.0.0.0" 20 | ``` 21 | 22 | **Option 2 (Use npx)** 23 | ``` 24 | npx -y playwright@1.51.0 run-server --port 3003 --host 0.0.0.0 25 | ``` 26 | 27 | ### 2. Authroize 28 | 29 | Use `ws://:3003` to authorize. 30 | 31 | ### 3. Execute script 32 | The script should like this: 33 | ``` 34 | page = browser.new_page(); page.goto('http://playwright.dev'); result = page.screenshot(); 35 | ``` 36 | using `;` to separate commands. Assign the final output to the variable `result`(only support string and bytes). Utilize the `browser` variable to access the browser object. 37 | 38 | ### 4. The agent can use this tool well 39 | ![agent](./_assets/agent.png) -------------------------------------------------------------------------------- /tools/playwright.py: -------------------------------------------------------------------------------- 1 | from collections.abc import Generator 2 | from typing import Any, Literal 3 | 4 | from dify_plugin import Tool 5 | from dify_plugin.entities.tool import ToolInvokeMessage 6 | from playwright.sync_api import sync_playwright 7 | 8 | 9 | def run_playwright(uri: str, commands: str, uri_type: Literal["ws", "cdp"]) -> str | bytes: 10 | with sync_playwright() as p: 11 | if uri_type == "ws": 12 | browser = p.chromium.connect(ws_endpoint=uri, timeout=3000) 13 | else: 14 | browser = p.chromium.connect_over_cdp(endpoint_url=uri, timeout=3000) 15 | local_vars = {"browser": browser} 16 | exec(commands, {}, local_vars) 17 | result = local_vars.get("result") 18 | 19 | return result 20 | 21 | 22 | class PlaywrightTool(Tool): 23 | def _invoke(self, tool_parameters: dict[str, Any]) -> Generator[ToolInvokeMessage]: 24 | commands = tool_parameters.get("script") 25 | result = run_playwright( 26 | self.runtime.credentials.get("playwright_uri"), commands, self.runtime.credentials.get("uri_type") 27 | ) 28 | if isinstance(result, str): 29 | yield self.create_text_message(result) 30 | elif isinstance(result, bytes): 31 | yield self.create_blob_message(blob=result, meta={"mime_type": "image/png"}) 32 | else: 33 | yield self.create_text_message("Nothing output") 34 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # UV 98 | # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | #uv.lock 102 | 103 | # poetry 104 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 105 | # This is especially recommended for binary packages to ensure reproducibility, and is more 106 | # commonly ignored for libraries. 107 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 108 | #poetry.lock 109 | 110 | # pdm 111 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 112 | #pdm.lock 113 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 114 | # in version control. 115 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 116 | .pdm.toml 117 | .pdm-python 118 | .pdm-build/ 119 | 120 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 121 | __pypackages__/ 122 | 123 | # Celery stuff 124 | celerybeat-schedule 125 | celerybeat.pid 126 | 127 | # SageMath parsed files 128 | *.sage.py 129 | 130 | # Environments 131 | .env 132 | .venv 133 | env/ 134 | venv/ 135 | ENV/ 136 | env.bak/ 137 | venv.bak/ 138 | 139 | # Spyder project settings 140 | .spyderproject 141 | .spyproject 142 | 143 | # Rope project settings 144 | .ropeproject 145 | 146 | # mkdocs documentation 147 | /site 148 | 149 | # mypy 150 | .mypy_cache/ 151 | .dmypy.json 152 | dmypy.json 153 | 154 | # Pyre type checker 155 | .pyre/ 156 | 157 | # pytype static type analyzer 158 | .pytype/ 159 | 160 | # Cython debug symbols 161 | cython_debug/ 162 | 163 | # PyCharm 164 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 165 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 166 | # and can be added to the global gitignore or merged into this file. For a more nuclear 167 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 168 | .idea/ 169 | 170 | # Vscode 171 | .vscode/ 172 | -------------------------------------------------------------------------------- /.difyignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # Distribution / packaging 7 | .Python 8 | build/ 9 | develop-eggs/ 10 | dist/ 11 | downloads/ 12 | eggs/ 13 | .eggs/ 14 | lib/ 15 | lib64/ 16 | parts/ 17 | sdist/ 18 | var/ 19 | wheels/ 20 | share/python-wheels/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | MANIFEST 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .nox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *.cover 46 | *.py,cover 47 | .hypothesis/ 48 | .pytest_cache/ 49 | cover/ 50 | 51 | # Translations 52 | *.mo 53 | *.pot 54 | 55 | # Django stuff: 56 | *.log 57 | local_settings.py 58 | db.sqlite3 59 | db.sqlite3-journal 60 | 61 | # Flask stuff: 62 | instance/ 63 | .webassets-cache 64 | 65 | # Scrapy stuff: 66 | .scrapy 67 | 68 | # Sphinx documentation 69 | docs/_build/ 70 | 71 | # PyBuilder 72 | .pybuilder/ 73 | target/ 74 | 75 | # Jupyter Notebook 76 | .ipynb_checkpoints 77 | 78 | # IPython 79 | profile_default/ 80 | ipython_config.py 81 | 82 | # pyenv 83 | # For a library or package, you might want to ignore these files since the code is 84 | # intended to run in multiple environments; otherwise, check them in: 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | Pipfile.lock 93 | 94 | # UV 95 | # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. 96 | # This is especially recommended for binary packages to ensure reproducibility, and is more 97 | # commonly ignored for libraries. 98 | uv.lock 99 | 100 | # poetry 101 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 102 | # This is especially recommended for binary packages to ensure reproducibility, and is more 103 | # commonly ignored for libraries. 104 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 105 | poetry.lock 106 | 107 | # pdm 108 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 109 | #pdm.lock 110 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 111 | # in version control. 112 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 113 | .pdm.toml 114 | .pdm-python 115 | .pdm-build/ 116 | 117 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 118 | __pypackages__/ 119 | 120 | # Celery stuff 121 | celerybeat-schedule 122 | celerybeat.pid 123 | 124 | # SageMath parsed files 125 | *.sage.py 126 | 127 | # Environments 128 | .env 129 | .venv 130 | env/ 131 | venv/ 132 | ENV/ 133 | env.bak/ 134 | venv.bak/ 135 | 136 | # Spyder project settings 137 | .spyderproject 138 | .spyproject 139 | 140 | # Rope project settings 141 | .ropeproject 142 | 143 | # mkdocs documentation 144 | /site 145 | 146 | # mypy 147 | .mypy_cache/ 148 | .dmypy.json 149 | dmypy.json 150 | 151 | # Pyre type checker 152 | .pyre/ 153 | 154 | # pytype static type analyzer 155 | .pytype/ 156 | 157 | # Cython debug symbols 158 | cython_debug/ 159 | 160 | # PyCharm 161 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 162 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 163 | # and can be added to the global gitignore or merged into this file. For a more nuclear 164 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 165 | .idea/ 166 | 167 | # Vscode 168 | .vscode/ 169 | 170 | # Git 171 | .git/ 172 | .gitignore 173 | 174 | # Mac 175 | .DS_Store 176 | 177 | # Windows 178 | Thumbs.db 179 | -------------------------------------------------------------------------------- /_assets/icon.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /GUIDE.md: -------------------------------------------------------------------------------- 1 | ## User Guide of how to develop a Dify Plugin 2 | 3 | Hi there, looks like you have already created a Plugin, now let's get you started with the development! 4 | 5 | ### Choose a Plugin type you want to develop 6 | 7 | Before start, you need some basic knowledge about the Plugin types, Plugin supports to extend the following abilities in Dify: 8 | - **Tool**: Tool Providers like Google Search, Stable Diffusion, etc. it can be used to perform a specific task. 9 | - **Model**: Model Providers like OpenAI, Anthropic, etc. you can use their models to enhance the AI capabilities. 10 | - **Endpoint**: Like Service API in Dify and Ingress in Kubernetes, you can extend a http service as an endpoint and control its logics using your own code. 11 | 12 | Based on the ability you want to extend, we have divided the Plugin into three types: **Tool**, **Model**, and **Extension**. 13 | 14 | - **Tool**: It's a tool provider, but not only limited to tools, you can implement an endpoint there, for example, you need both `Sending Message` and `Receiving Message` if you are building a Discord Bot, **Tool** and **Endpoint** are both required. 15 | - **Model**: Just a model provider, extending others is not allowed. 16 | - **Extension**: Other times, you may only need a simple http service to extend the functionalities, **Extension** is the right choice for you. 17 | 18 | I believe you have chosen the right type for your Plugin while creating it, if not, you can change it later by modifying the `manifest.yaml` file. 19 | 20 | ### Manifest 21 | 22 | Now you can edit the `manifest.yaml` file to describe your Plugin, here is the basic structure of it: 23 | 24 | - version(version, required)：Plugin's version 25 | - type(type, required)：Plugin's type, currently only supports `plugin`, future support `bundle` 26 | - author(string, required)：Author, it's the organization name in Marketplace and should also equals to the owner of the repository 27 | - label(label, required)：Multi-language name 28 | - created_at(RFC3339, required)：Creation time, Marketplace requires that the creation time must be less than the current time 29 | - icon(asset, required)：Icon path 30 | - resource (object)：Resources to be applied 31 | - memory (int64)：Maximum memory usage, mainly related to resource application on SaaS for serverless, unit bytes 32 | - permission(object)：Permission application 33 | - tool(object)：Reverse call tool permission 34 | - enabled (bool) 35 | - model(object)：Reverse call model permission 36 | - enabled(bool) 37 | - llm(bool) 38 | - text_embedding(bool) 39 | - rerank(bool) 40 | - tts(bool) 41 | - speech2text(bool) 42 | - moderation(bool) 43 | - node(object)：Reverse call node permission 44 | - enabled(bool) 45 | - endpoint(object)：Allow to register endpoint permission 46 | - enabled(bool) 47 | - app(object)：Reverse call app permission 48 | - enabled(bool) 49 | - storage(object)：Apply for persistent storage permission 50 | - enabled(bool) 51 | - size(int64)：Maximum allowed persistent memory, unit bytes 52 | - plugins(object, required)：Plugin extension specific ability yaml file list, absolute path in the plugin package, if you need to extend the model, you need to define a file like openai.yaml, and fill in the path here, and the file on the path must exist, otherwise the packaging will fail. 53 | - Format 54 | - tools(list[string]): Extended tool suppliers, as for the detailed format, please refer to [Tool Guide](https://docs.dify.ai/plugins/schema-definition/tool) 55 | - models(list[string])：Extended model suppliers, as for the detailed format, please refer to [Model Guide](https://docs.dify.ai/plugins/schema-definition/model) 56 | - endpoints(list[string])：Extended Endpoints suppliers, as for the detailed format, please refer to [Endpoint Guide](https://docs.dify.ai/plugins/schema-definition/endpoint) 57 | - Restrictions 58 | - Not allowed to extend both tools and models 59 | - Not allowed to have no extension 60 | - Not allowed to extend both models and endpoints 61 | - Currently only supports up to one supplier of each type of extension 62 | - meta(object) 63 | - version(version, required)：manifest format version, initial version 0.0.1 64 | - arch(list[string], required)：Supported architectures, currently only supports amd64 arm64 65 | - runner(object, required)：Runtime configuration 66 | - language(string)：Currently only supports python 67 | - version(string)：Language version, currently only supports 3.12 68 | - entrypoint(string)：Program entry, in python it should be main 69 | 70 | ### Install Dependencies 71 | 72 | - First of all, you need a Python 3.11+ environment, as our SDK requires that. 73 | - Then, install the dependencies: 74 | ```bash 75 | pip install -r requirements.txt 76 | ``` 77 | - If you want to add more dependencies, you can add them to the `requirements.txt` file, once you have set the runner to python in the `manifest.yaml` file, `requirements.txt` will be automatically generated and used for packaging and deployment. 78 | 79 | ### Implement the Plugin 80 | 81 | Now you can start to implement your Plugin, by following these examples, you can quickly understand how to implement your own Plugin: 82 | 83 | - [OpenAI](https://github.com/langgenius/dify-plugin-sdks/tree/main/python/examples/openai): best practice for model provider 84 | - [Google Search](https://github.com/langgenius/dify-plugin-sdks/tree/main/python/examples/google): a simple example for tool provider 85 | - [Neko](https://github.com/langgenius/dify-plugin-sdks/tree/main/python/examples/neko): a funny example for endpoint group 86 | 87 | ### Test and Debug the Plugin 88 | 89 | You may already noticed that a `.env.example` file in the root directory of your Plugin, just copy it to `.env` and fill in the corresponding values, there are some environment variables you need to set if you want to debug your Plugin locally. 90 | 91 | - `INSTALL_METHOD`: Set this to `remote`, your plugin will connect to a Dify instance through the network. 92 | - `REMOTE_INSTALL_HOST`: The host of your Dify instance, you can use our SaaS instance `https://debug.dify.ai`, or self-hosted Dify instance. 93 | - `REMOTE_INSTALL_PORT`: The port of your Dify instance, default is 5003 94 | - `REMOTE_INSTALL_KEY`: You should get your debugging key from the Dify instance you used, at the right top of the plugin management page, you can see a button with a `debug` icon, click it and you will get the key. 95 | 96 | Run the following command to start your Plugin: 97 | 98 | ```bash 99 | python -m main 100 | ``` 101 | 102 | Refresh the page of your Dify instance, you should be able to see your Plugin in the list now, but it will be marked as `debugging`, you can use it normally, but not recommended for production. 103 | 104 | ### Package the Plugin 105 | 106 | After all, just package your Plugin by running the following command: 107 | 108 | ```bash 109 | dify-plugin plugin package ./ROOT_DIRECTORY_OF_YOUR_PLUGIN 110 | ``` 111 | 112 | you will get a `plugin.difypkg` file, that's all, you can submit it to the Marketplace now, look forward to your Plugin being listed! 113 | 114 | 115 | ## User Privacy Policy 116 | 117 | Please fill in the privacy policy of the plugin if you want to make it published on the Marketplace, refer to [PRIVACY.md](PRIVACY.md) for more details. --------------------------------------------------------------------------------