docs(sdk): custom-tools 'register_tool' example passes a factory function, which raises TypeError

Abierto Apto para principiantes
#1,068 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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

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 full BashAndGrepToolSet example.
  • Likely also sdk/guides/agent-server/custom-tools.mdx and sdk/arch/tool-system.mdx.
Suggested fix
  • Register each ToolDefinition subclass/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/ToolSet rather 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

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OpenHands/docs

Todos los issues de OpenHands/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.