Skip to content

docs: default custom tool creation to plugins#19755

Merged
kshitijk4poor merged 1 commit into
mainfrom
docs/plugin-tool-default
May 4, 2026
Merged

docs: default custom tool creation to plugins#19755
kshitijk4poor merged 1 commit into
mainfrom
docs/plugin-tool-default

Conversation

@kshitijk4poor

Copy link
Copy Markdown
Collaborator

Salvage of PR #13138 by @helix4u.

Steers custom tool creation toward the plugin route by default. The adding-tools.md guide is now explicitly for built-in core Hermes tools only.

Critical fix: The plugin quickstart example in plugins.md used the old incorrect 3-arg ctx.register_tool("hello_world", schema, handle_hello) call which TypeErrors at runtime. Fixed to use the current keyword-arg API with toolset= parameter, correct handler signature (params, **kwargs), and json.dumps() return.

Changes (5 files):

  • AGENTS.md — mention plugin route before built-in tool instructions
  • website/docs/developer-guide/adding-tools.md — add warning banner, rename steps to "Built-in", add plugin-check to checklist
  • website/docs/developer-guide/contributing.md — separate plugin vs core tool paths
  • website/docs/getting-started/learning-path.md — plugins listed before core tool dev
  • website/docs/user-guide/features/plugins.md — fix quickstart example + add steering note

Steers custom tool creation toward the plugin route by default.
The adding-tools.md guide is now explicitly for built-in core Hermes
tools only.

Key fixes:
- Plugin quickstart: ctx.register_tool() now uses correct keyword-arg
  API (name=, toolset=, schema=, handler=) instead of broken 3-arg call
- Handler signature: (params, **kwargs) instead of (params)
- Handler return: json.dumps({...}) instead of plain string
- AGENTS.md: mentions plugin route before built-in tool instructions
- learning-path.md: plugins listed before core tool development
- contributing.md: separates plugin vs core tool paths

Based on PR #13138 by @helix4u.
@kshitijk4poor kshitijk4poor merged commit eeb05cf into main May 4, 2026
4 of 7 checks passed
@kshitijk4poor kshitijk4poor deleted the docs/plugin-tool-default branch May 4, 2026 12:53
@alt-glitch alt-glitch added type/docs Documentation improvements comp/plugins Plugin system and bundled plugins P3 Low — cosmetic, nice to have labels May 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp/plugins Plugin system and bundled plugins P3 Low — cosmetic, nice to have type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants