docs: add a minimal custom plugin template (#889)#899
Open
jmgomezl wants to merge 1 commit into
Open
Conversation
Adds a 'Creating a Custom Plugin' section to HEDERAPLUGINS.md with a copy-paste TypeScript template: Plugin/Tool/Context imports, a Zod parameter schema, a plain-object tool with execute(client, context, params), and registration alongside the core plugins. Includes a short note on when to extend BaseTool instead (for hook/policy coverage), linking the existing examples/plugin/example-plugin.ts. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: jmgomezl <juanmag.lpez@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Adds a "Creating a Custom Plugin" section to the plugin docs, addressing #889.
It gives a minimal, copy-paste TypeScript template so teams can stand up their own plugin quickly:
Plugin/Tool/Contextimports from@hashgraph/hedera-agent-kitexecute(client, context, params)coreAccountQueryPlugin,coreConsensusPlugin)BaseToolinstead, for hook/policy coverageThe existing
examples/plugin/example-plugin.tsis a great fullBaseToolreference, so I kept this focused on the quick-start path and linked out to that example for the advanced case.Docs-only change, additive.