Skip to main content

Creating a Plugin

Plugin Interface

Every plugin corresponds to the Plugin class:

Tool Interface

Each tool must assume the Tool class structure:
See hedera_agent_kit/shared/tool.py for the full definition.

Creating a Plugin

Step 1: Create Plugin Structure

Step 2: Implement Your Tool

Step 3: Create Plugin Definition


Using Your Plugin

Publish and Register Your Plugin

To create a plugin to be use with the Hedera Agent Kit, you will need to create a plugin in your own repository, publish an npm package, and provide a description of the functionality included in that plugin, as well as the required and optional parameters. Once you have a repository, published npm package, and a README with a description of the functionality included in that plugin in your plugin’s repo, as well, add it to the Hedera Agent Kit by forking and opening a Pull Request that includes:
  1. Include the plugin as a bullet point under the Third Party Plugin section in the README.md in the hedera-agent-kit-py.
    • Include the name, a brief description, and a link to the repository with the README, as well the URL linked to the published npm package.
  2. If you would like to include your plugin functionality in the Hedera plugin built for ElizaOS simply make a PR to add your plugin name to the plugins array in the Hedera ElizaOS plugin where the configuration is initiated. The hedera-agent-kit adaptor architecture means your plugin functionality will be usable with no additional configuration needed.
Please also reach out in the Hedera Discord in the Support > developer-help-desk channel or create an Issue in this repository for help building, publishing, and promoting your plugin.

Plugin README Template

Resources