docs(sdk): custom-tools 'register_tool' example passes a factory function, which raises TypeError
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 62/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- documentation, python
- Área
- documentation
Línea de trabajo
Empieza con sdk/guides/custom-tools.mdx, las secciones “Tool Registration” y “Factory Functions” y el ejemplo BashAndGrepToolSet. Luego revisa openhands-sdk/openhands/sdk/tool/registry.py para confirmar que register_tool solo acepta una instancia o una subclase de ToolDefinition. Revisa también sdk/guides/agent-server/custom-tools.mdx y sdk/arch/tool-system.mdx para detectar el mismo patrón. Se considera terminado cuando cada ejemplo registra herramientas en una forma compatible y la documentación ya no muestra una función de fábrica pasada a register_tool.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- MDX
- Estrellas
- 19
- Forks
- 104
- Merge medio
- 2 d 12 h
- PR fusionados (30 d)
- 80
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Sin guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de OpenHands/docs
-
docs: document FORGEJO_BASE_URL (self-hosted Forgejo host for the backend integration)Posiblemente ocupada @remote-controlled-man la tomó hace 18 días. Abierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 83/100
Los mantenedores suelen responder en 1 día
-
Docs: Child Conversations incorrectly implies the child's result is returned to the parentPosiblemente ocupada @sahithib20 la tomó hace 36 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
OpenHands/docs#658 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
agent-in-progress
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
Los mantenedores suelen responder en 1 día
Todos los issues de OpenHands/docs
Issues similares
-
[Docs] CONTRIBUTING points the Backend Remake milestone at a branch that does not existPosiblemente ocupada @franpts2 la tomó hoy. Abiertodocs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
Los mantenedores suelen responder en 3 días
-
postgresql-rules / queue-rules: implicit KEY SHARE before a parent key update, and job self-overlapAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
jonathanong/no-mistakes#3879 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
cloudflare/nimbus#423 ·
Los mantenedores suelen responder en 1 día
-
review developer setup docAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
NYCPlanning/data-engineering#2996 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 2 días