docs(sdk): custom-tools 'register_tool' example passes a factory function, which raises TypeError
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 62/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- documentation, python
調査の方向性
sdk/guides/custom-tools.mdx の「Tool Registration」と「Factory Functions」のセクション、および BashAndGrepToolSet の例から始めてください。次に openhands-sdk/openhands/sdk/tool/registry.py で、register_tool が ToolDefinition のインスタンスまたはサブクラスのみを受け付けることを確認してください。同じパターンがないか、sdk/guides/agent-server/custom-tools.mdx と sdk/arch/tool-system.mdx も確認してください。すべての例がサポートされた形式でツールを登録し、ドキュメントでファクトリ関数を register_tool に渡している箇所がなくなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Problem
sdk/guides/custom-tools.mdx documents registering a factory function with register_tool():
# Register a factory function that creates multiple tools
register_tool("BashAndGrepToolSet", _make_bash_and_grep_tools)
But the current SDK signature only accepts a ToolDefinition instance or a ToolDefinition subclass:
# openhands-sdk/openhands/sdk/tool/registry.py
def register_tool(
name: str,
factory: ToolDefinition | type[ToolDefinition],
) -> None:
...
else:
raise TypeError(
"register_tool(...) only accepts: (1) a ToolDefinition instance with "
".executor, or (2) a ToolDefinition subclass with .create(**params)"
)
So the documented pattern raises at runtime:
TypeError: register_tool(...) only accepts: (1) a ToolDefinition instance with .executor,
or (2) a ToolDefinition subclass with .create(**params)
Where
sdk/guides/custom-tools.mdx— "Good to know → Tool Registration" and "Factory Functions" sections,
plus the fullBashAndGrepToolSetexample.- Likely also
sdk/guides/agent-server/custom-tools.mdxandsdk/arch/tool-system.mdx.
Suggested fix
- Register each
ToolDefinitionsubclass/instance individually (or loop over a list) instead of passing a
factory function. - If the "tool set" pattern is still desired, show it via
TaskToolSet/ToolSetrather than a raw factory.
Reported by
A user (Epsilon Software Inc) hit this following the docs; confirmed against openhands-sdk source.
This issue was created by an AI agent (OpenHands) on behalf of the maintainer.
- 主要言語
- MDX
- スター
- 19
- フォーク
- 104
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 80
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenHands/docs のほかの issue
-
docs: document FORGEJO_BASE_URL (self-hosted Forgejo host for the backend integration)対応中かも @remote-controlled-man が 18 日前に担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 1 日以内に返信
-
Docs: Child Conversations incorrectly implies the child's result is returned to the parent対応中かも @sahithib20 が 36 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
OpenHands/docs#658 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
agent-in-progress
難易度 3/5 1〜2日 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
[Docs] CONTRIBUTING points the Backend Remake milestone at a branch that does not exist対応中かも @franpts2 が今日担当しました。 オープンdocs
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
メンテナーはふだん 3 日以内に返信
-
postgresql-rules / queue-rules: implicit KEY SHARE before a parent key update, and job self-overlapオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
jonathanong/no-mistakes#3879 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
cloudflare/nimbus#423 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
NYCPlanning/data-engineering#2996 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 2 日以内に返信