Skip to main content
Glama
  • :rocket: Serena es un poderoso kit de herramientas de agente de codificación capaz de convertir un LLM en un agente con todas las funciones que trabaja directamente en su base de código .

  • :wrench: Serena proporciona herramientas esenciales de recuperación y edición de código semántico que son similares a las capacidades de un IDE, extrayendo entidades de código a nivel de símbolo y explotando la estructura relacional.

  • :free: Serena es gratuita y de código abierto , lo que mejora las capacidades de los LLM a los que ya tienes acceso de forma gratuita.

Demostración

Aquí se muestra una demostración de cómo Serena implementa una pequeña función (una mejor interfaz gráfica de usuario de registro) con Claude Desktop. Observe cómo las herramientas de Serena permiten a Claude encontrar y editar los símbolos adecuados.

https://github.com/user-attachments/assets/6eaa9aa1-610d-4723-a2d6-bf1e487ba753

Integración de LLM

Serena proporciona las herramientas necesarias para codificar flujos de trabajo, pero se requiere un LLM para realizar el trabajo real y orquestar el uso de las herramientas.

Serena se puede integrar con un LLM de varias maneras:

  • mediante el uso del protocolo de contexto de modelo (MCP) .
    Serena proporciona un servidor MCP que se integra con

    • Claude Desktop,

    • IDE como VSCode, Cursor o IntelliJ,

    • Extensiones como Cline o Roo Code

    • Goose (para una buena experiencia CLI)

    • y muchos otros, incluida la aplicación ChatGPT próximamente

  • mediante el uso de Agno, el marco de agente agnóstico del modelo .
    El agente basado en Agno de Serena le permite convertir prácticamente cualquier LLM en un agente de codificación, ya sea proporcionado por Google, OpenAI o Anthropic (con una clave API paga) o un modelo gratuito proporcionado por Ollama, Together o Anyscale.

  • incorporando las herramientas de Serena en un marco de agente de su elección.
    La implementación de la herramienta Serena está desacoplada del código específico del marco y, por lo tanto, se puede adaptar fácilmente a cualquier marco de agente.

Compatibilidad con lenguajes de programación y capacidades de análisis semántico

Las capacidades de análisis de código semántico de Serena se basan en servidores de lenguaje que utilizan el protocolo de servidor de lenguaje (LSP), ampliamente implementado. El LSP proporciona un conjunto versátil de funcionalidades de consulta y edición de código basadas en la comprensión simbólica del código. Equipada con estas capacidades, Serena descubre y edita código como lo haría un desarrollador experimentado que utiliza las capacidades de un IDE. Serena puede encontrar eficientemente el contexto adecuado y hacer lo correcto incluso en proyectos muy grandes y complejos. Por lo tanto, no solo es gratuito y de código abierto, sino que a menudo logra mejores resultados que las soluciones existentes de pago.

Los servidores de idiomas ofrecen compatibilidad con una amplia gama de lenguajes de programación. Con Serena, ofrecemos...

  • Soporte directo y listo para usar para:

    • Pitón

    • TypeScript/Javascript

    • PHP

    • Go (primero es necesario instalar go y gopls)

    • Óxido

    • C/C++

    • Java ( Nota : el inicio es lento, especialmente el inicio inicial. Parece haber problemas con Java en macOS)

  • Soporte indirecto (puede requerir algunos cambios de código/instalación manual) para:

    • Ruby (no probado)

    • C# (no probado)

    • Kotlin (no probado)

    • Dart (no probado)

    Estos idiomas son compatibles con la biblioteca de servidores de idiomas multilspy , que Serena utiliza internamente. Sin embargo, no probamos explícitamente si la compatibilidad con estos idiomas funciona realmente.

En principio, se pueden soportar más idiomas fácilmente proporcionando un adaptador superficial para una nueva implementación del servidor de idiomas.

Tabla de contenido

Related MCP server: Nabu + Nisaba

¿Para qué puedo utilizar Serena?

Puede usar Serena para cualquier tarea de codificación, ya sea centrada en el análisis, la planificación, el diseño de nuevos componentes o la refactorización de los existentes. Dado que las herramientas de Serena permiten que un LLM cierre el ciclo cognitivo de percepción-acción, los agentes basados en Serena pueden realizar tareas de codificación de forma autónoma de principio a fin, desde el análisis inicial hasta la implementación, las pruebas y, finalmente, la confirmación del sistema de control de versiones.

Serena puede leer, escribir y ejecutar código, así como leer registros y la salida del terminal. Si bien no lo recomendamos necesariamente, la programación con vibración es posible, y si desea sentir que el código ya no existe, Serena podría ser incluso más adecuada para la vibración que un agente dentro de un IDE (ya que dispondrá de una interfaz gráfica de usuario independiente que le permitirá olvidarse por completo).

Agentes de codificación gratuitos con Serena

Incluso la versión gratuita de Claude de Anthropic es compatible con servidores MCP, por lo que puedes usar Serena con Claude gratis. Probablemente, pronto será posible hacer lo mismo con ChatGPT Desktop una vez que se incorpore la compatibilidad con servidores MCP.
A través de Agno, además tienes la opción de utilizar Serena con un modelo de pesas libres/abiertas.

Serena es la contribución de Oraios AI a la comunidad de desarrolladores.
Nosotros mismos lo utilizamos habitualmente.

Nos cansamos de tener que pagar varias suscripciones basadas en IDE (como Windsurf o Cursor), lo que nos obligaba a seguir comprando tokens además de los costos de suscripción de chat que ya teníamos. Los altos costos de API de herramientas como Claude Code, Cline, Aider y otras herramientas basadas en API son igualmente poco atractivos. Por lo tanto, creamos Serena con la posibilidad de cancelar la mayoría de las demás suscripciones.

Inicio rápido

Serena se puede utilizar de varias maneras, a continuación encontrará instrucciones para integraciones seleccionadas.

  • Si solo desea convertir a Claude en un agente de codificación de uso gratuito, le recomendamos utilizar Serena a través de Claude Desktop.

  • Si quieres usar Gemini o cualquier otro modelo y quieres una interfaz gráfica, deberías usar Agno . En macOS, también puedes usar la interfaz gráfica de Goose .

  • Si prefieres usar Serena mediante una CLI, puedes usar goose . En este caso, prácticamente cualquier modelo es compatible.

  • Si desea utilizar Serena integrado en su IDE, consulte la sección sobre otros clientes MCP .

Configuración y configuración

  1. Instalar uv (instrucciones aquí )

  2. Clonar el repositorio en /path/to/serena .

  3. Copie serena_config.template.yml en serena_config.yml y ajuste la configuración.

    cp serena_config.template.yml serena_config.yml
  4. Copia project.template.yml en project.yml y ajusta la configuración específica de tu proyecto (añade un archivo similar por cada proyecto en el que quieras que Serena trabaje). Te recomendamos copiarlo al directorio .serena de tu proyecto, por ejemplo:

    mkdir -p /myproject/.serena
    cp project.template.yml /myproject/.serena/project.yml
  5. Si desea que Serena cambie dinámicamente entre proyectos, agregue la lista de todos los archivos de proyecto creados en el paso anterior a la lista projects en serena_config.yml .

⚠️ Nota: Serena se encuentra en desarrollo activo. Añadimos funciones continuamente, mejoramos la estabilidad y la experiencia de usuario (UX). Por lo tanto, la configuración puede cambiar de forma perjudicial. Si su configuración no es válida, el servidor MCP o el agente basado en Serena podrían no iniciarse (consulte los registros de MCP en el primer caso). Consulte el registro de cambios y las plantillas de configuración al actualizar Serena y adapte sus configuraciones según corresponda.

Después de la configuración inicial, continúe con una de las secciones siguientes, dependiendo de cómo desee utilizar Serena.

Servidor MCP (Claude Desktop)

  1. Cree un archivo de configuración para su proyecto, digamos myproject.yml basado en la plantilla en myproject.template.yml .

  2. Configure el servidor MCP en su cliente.
    Para Claude Desktop (disponible para Windows y macOS), vaya a Archivo / Configuración / Desarrollador / Servidores MCP / Editar configuración. Esto le permitirá abrir el archivo JSON claude_desktop_config.json . Agregue lo siguiente (con las rutas ajustadas) para habilitar Serena:

    {
        "mcpServers": {
            "serena": {
                "command": "/abs/path/to/uv",
                "args": ["run", "--directory", "/abs/path/to/serena", "serena-mcp-server", "--project", "/abs/path/to/project"]
            }
        }
    }

    :info: Pasar el archivo del proyecto es opcional si ha configurado enable_project_activation , ya que esta configuración le permitirá simplemente indicarle a Claude que active el proyecto en el que desea trabajar.

    • Para Claude Desktop (como se muestra arriba), el contexto predeterminado de Serena ( desktop-app ) y los modos (p. ej., interactive , editing ) suelen ser adecuados para uso general. Normalmente no es necesario especificarlos explícitamente en los args a menos que se deseen anular los valores predeterminados.

    • Para integraciones IDE (como VSCode, Cursor, Cline, etc., configuradas añadiendo Serena como servidor MCP), debe pasar explícitamente el contexto ide-assistant añadiendo "--context", "ide-assistant" a los args en la configuración de su cliente MCP. También puede especificar los modos iniciales si lo desea (p. ej., "--mode", "editing" ).

    • Para tareas específicas de una sola toma en cualquier cliente (por ejemplo, generar un informe o un plan en una sola interacción), es posible que desee indicarle a Serena (una vez conectada) que cambie a modos como planning y one-shot usando la herramienta switch_modes , o configurarlos inicialmente a través de los indicadores --mode si configura el comando de inicio del servidor directamente para dichas tareas.

    Consulte la sección Modos y contextos para obtener más detalles sobre las opciones disponibles y la personalización.

    Si está utilizando rutas que contienen barras invertidas para rutas en Windows (tenga en cuenta que también puede usar barras diagonales), asegúrese de escaparlas correctamente ( \\ ).

¡Listo! Guarda la configuración y reinicia Claude Desktop.

Solución de problemas

Se ha informado que algunas configuraciones de cliente/SO/configuración causan problemas al usar Serena con el protocolo stdio estándar, donde la aplicación cliente inicia el servidor MCP. Si experimenta estos problemas, puede iniciar Serena en modo sse ejecutando, por ejemplo,

uv run --directory /path/to/serena serena-mcp-server --transport sse --port 9121 --project /path/to/project

(La opción --project es opcional). Luego, configure su cliente para que se conecte a http://localhost:9121 .

Nota: en Windows y macOS hay aplicaciones oficiales de Claude Desktop de Anthropic, para Linux hay una versión comunitaria de código abierto .

⚠️ Asegúrate de salir por completo de la aplicación Claude Desktop, ya que cerrar Claude simplemente la minimizará en la bandeja del sistema, al menos en Windows.

Después de reiniciar, deberías ver las herramientas de Serena en tu interfaz de chat (observa el pequeño ícono del martillo).

⚠️ Nombres de herramientas: Claude Desktop (y la mayoría de los clientes MCP) no resuelven el nombre del servidor. Por lo tanto, no debería decir algo como "usar las herramientas de Serena". En su lugar, puede indicarle al LLM que use herramientas simbólicas o una herramienta específica haciendo referencia a su nombre. Además, si utiliza varios servidores MCP, podría experimentar conflictos de nombres de herramientas que provoquen un comportamiento indefinido. Por ejemplo, Serena actualmente es incompatible con el servidor MCP del sistema de archivos debido a conflictos de nombres de herramientas.

Tenga en cuenta que los servidores MCP que utilizan stdio como protocolo son algo inusuales en cuanto a arquitecturas cliente/servidor, ya que el cliente debe iniciar el servidor para que la comunicación se realice a través de su flujo de entrada/salida estándar. En otras palabras, no necesita iniciar el servidor usted mismo. La aplicación cliente (p. ej., Claude Desktop) se encarga de esto y, por lo tanto, debe configurarse con un comando de inicio.

Para obtener más información sobre los servidores MCP con Claude Desktop, consulte la guía de inicio rápido oficial .

Claude Code

Serena es una excelente manera de hacer que Claude Code sea más económico y potente. Estamos recopilando varios ejemplos y hemos recibido comentarios muy positivos. Los usuarios de Claude Code pueden agregar Serena con

claude mcp add serena -- /path/to/uv "run" --directory /path/to/serena serena-mcp-server --project-file /path/to/project

Otros clientes MCP: Cline, Roo-Code, Cursor, Windsurf, etc.

Al ser un servidor MCP, Serena puede incluirse en cualquier cliente MCP. La misma configuración anterior, quizás con pequeñas modificaciones específicas del cliente, debería funcionar. La mayoría de los asistentes de programación populares (extensiones IDE o IDE similares a VSCode) aceptan la conexión a servidores MCP. Se recomienda usar el contexto ide-assistant para estas integraciones, añadiendo "--context", "ide-assistant" a los args en la configuración del cliente MCP. Incluir Serena generalmente mejora su rendimiento al proporcionarles herramientas para operaciones simbólicas.

En este caso, la facturación por uso sigue estando a cargo del cliente que usted elija (a diferencia del cliente Claude Desktop). Sin embargo, es posible que aún desee usar Serena con este enfoque, por ejemplo, por alguna de las siguientes razones:

  1. Ya estás utilizando un asistente de codificación (por ejemplo, Cline o Cursor) y solo quieres hacerlo más potente.

  2. Estás en Linux y no quieres usar el escritorio Claude creado por la comunidad

  3. Quiere una integración más estrecha de Serena en su IDE y no le importa pagar por ello

Aquí también se aplican las mismas consideraciones que al utilizar Serena para Claude Desktop (en particular, colisiones de nombres de herramientas).

Al usar Serena en un IDE o extensión con interacciones de IA integradas para programación (que, en realidad, son todas), el conjunto completo de herramientas de Serena puede generar interacciones no deseadas con las herramientas internas del cliente, sobre las que el usuario podría no tener control. Esto aplica especialmente a las herramientas de edición, que quizás desee desactivar para este propósito. A medida que adquiramos más experiencia con Serena en los diversos clientes populares, recopilaremos y mejoraremos las mejores prácticas para garantizar una experiencia fluida.

Ganso

Goose es un agente de codificación independiente que se integra con servidores MCP y ofrece una interfaz de línea de comandos (CLI) (y una interfaz gráfica de usuario en macOS). Usar Goose es actualmente la forma más sencilla de ejecutar Serena mediante una CLI con un LLM de su elección.

Siga las instrucciones aquí para instalarlo.

Después, usa goose configure para agregar una extensión. Para agregar Serena, elige la opción Command-line Extension , nómbrala Serena y agrega el siguiente comando:

/abs/path/to/uv run --directory /abs/path/to/serena serena-mcp-server --project /optional/abs/path/to/project

Dado que Serena puede realizar todas las operaciones de edición y comandos necesarias, debes desactivar la extensión developer que Goose habilita por defecto. Para ello, ejecuta

goose configure

Nuevamente, elija la opción Toggle Extensions y asegúrese de que Serena esté habilitada y la opción de developer no.

Eso es todo. Revisa las opciones de configuración de Goose para ver qué puedes hacer con él (que son muchas, como configurar diferentes niveles de permisos para la ejecución de herramientas).

Goose no siempre termina correctamente los procesos de Python en servidores MCP al finalizar una sesión. Le recomendamos deshabilitar la interfaz gráfica de Serena o limpiar manualmente cualquier proceso de Python en ejecución después de terminar de trabajar con Goose.

Agente Agno

Agno es un framework de agente independiente del modelo que permite convertir Serena en un agente (independiente de la tecnología MCP) con una gran cantidad de LLM subyacentes. Actualmente, Agno es la forma más sencilla de ejecutar Serena en una interfaz gráfica de chat con el LLM que prefiera (a menos que use un Mac, en cuyo caso podría preferir Goose, que prácticamente no requiere configuración).

Aunque Agno aún no es completamente estable, lo elegimos porque cuenta con su propia interfaz de usuario de código abierto, lo que facilita el uso directo del agente mediante una interfaz de chat. Con Agno, Serena se convierte en un agente (ya no es un servidor MCP), lo que permite su uso programático (por ejemplo, para benchmarking o dentro de la aplicación).

Así es como funciona (ver también la documentación de Agno ):

  1. Descargue el código del agente-ui con npx

    npx create-agent-ui@latest

    o, alternativamente, clonarlo manualmente:

    git clone https://github.com/agno-agi/agent-ui.git
    cd agent-ui 
    pnpm install 
    pnpm dev
  2. Instalar serena con los requisitos opcionales:

    # You can also only select agno,google or agno,anthropic instead of all-extras
    uv pip install --all-extras -r pyproject.toml -e .
  3. Copie .env.example a .env y complete las claves API para los proveedores que desee utilizar.

  4. Inicie la aplicación agno agent con

    uv run python scripts/agno_agent.py

    De forma predeterminada, el script utiliza a Claude como modelo, pero puedes elegir cualquier modelo compatible con Agno (que es esencialmente cualquier modelo existente).

  5. En una nueva terminal, inicie la interfaz de usuario de agno con

    cd agent-ui 
    pnpm dev

    Conecta la interfaz de usuario al agente que iniciaste anteriormente y empieza a chatear. Tendrás las mismas herramientas que en la versión del servidor MCP.

A continuación se muestra una breve demostración de Serena realizando una pequeña tarea de análisis con el modelo Gemini más nuevo:

https://github.com/user-attachments/assets/ccfcb968-277d-4ca9-af7f-b84578858c62

⚠️ IMPORTANTE: A diferencia del enfoque del servidor MCP, la ejecución de herramientas en la interfaz de usuario de Agno no solicita permiso al usuario. La herramienta de shell es especialmente crítica, ya que puede ejecutar código arbitrario. Si bien nunca hemos tenido problemas con esto en nuestras pruebas con Claude, permitirlo podría no ser del todo seguro. Puede deshabilitar ciertas herramientas para su configuración en el archivo de configuración de su proyecto Serena ( .yml ).

Otros marcos de agentes

El agente Agno es particularmente bueno debido a la interfaz de usuario de Agno, pero es fácil incorporar Serena en cualquier marco de agente (como pydantic-ai , langgraph u otros).

Solo tienes que escribir un adaptador de las herramientas de Serena a las herramientas del framework de tu elección, tal como lo hicimos nosotros para agno en SerenaAgnoToolkit .

Herramientas y configuración de Serena

Serena combina herramientas para la recuperación de código semántico con funciones de edición y ejecución de shell. El comportamiento de Serena se puede personalizar aún más mediante Modos y Contextos . Encuentre la lista completa de herramientas a continuación .

Generalmente se recomienda el uso de todas las herramientas, ya que esto permite que Serena proporcione el mayor valor: solo ejecutando comandos de shell (en particular, pruebas) Serena puede identificar y corregir errores de forma autónoma.

Sin embargo, cabe destacar que la herramienta execute_shell_command permite la ejecución de código arbitrario. Al usar Serena como servidor MCP, los clientes suelen solicitar permiso al usuario antes de ejecutar una herramienta, por lo que, siempre que el usuario inspeccione los parámetros de ejecución previamente, esto no debería ser un problema. Sin embargo, si tiene dudas, puede deshabilitar ciertos comandos en el archivo de configuración .yml de su proyecto. Si solo desea usar Serena para analizar código y sugerir implementaciones sin modificar el código base, puede habilitar el modo de solo lectura configurando read_only: true en el archivo de configuración de su proyecto. Esto deshabilitará automáticamente todas las herramientas de edición y evitará cualquier modificación en el código base, a la vez que permite todas las funciones de análisis y exploración.

En general, asegúrese de realizar una copia de seguridad de su trabajo y utilizar un sistema de control de versiones para evitar perder cualquier trabajo.

Comparación con otros agentes de codificación

Hasta donde sabemos, Serena es el primer agente de codificación con todas las funciones, donde toda la funcionalidad está disponible a través de un servidor MCP, por lo que no requiere claves API ni suscripciones.

Agentes de codificación basados en suscripción

Los agentes de programación por suscripción más destacados forman parte de IDE como Windsurf, Cursor y VSCode. La funcionalidad de Serena es similar a la del Agente de Cursor, la Cascada de Windsurf o el próximo modo de agente de VSCode.

Serena tiene la ventaja de no requerir suscripción. Una posible desventaja es que no está integrado directamente en un IDE, por lo que la inspección del código recién escrito no es tan fluida.

Las diferencias más técnicas son:

  • Serena no está vinculada a un IDE específico. El servidor MCP de Serena puede usarse con cualquier cliente MCP (incluidos algunos IDE), y el agente basado en Agno ofrece otras maneras de aplicar su funcionalidad.

  • Serena no está vinculada a un modelo de lenguaje grande o API específico.

  • Serena navega y edita código mediante un servidor de lenguaje, por lo que tiene una comprensión simbólica del código. Las herramientas basadas en IDE suelen utilizar un enfoque basado en RAG o puramente en texto, que suele ser menos potente, especialmente para bases de código extensas.

  • Serena es de código abierto y tiene una base de código pequeña, por lo que se puede ampliar y modificar fácilmente.

Agentes de codificación basados en API

Una alternativa a los agentes basados en suscripción son los agentes basados en API como Claude Code, Cline, Aider, Roo Code y otros, donde los costes de uso se corresponden directamente con los costes de API del LLM subyacente. Algunos de ellos (como Cline) incluso pueden incluirse en IDEs como extensión. Suelen ser muy potentes y su principal desventaja son los costes de API (potencialmente muy elevados).

Serena puede usarse como agente basado en API (véase la sección sobre Agno más arriba). Aún no hemos desarrollado una herramienta CLI ni una extensión IDE dedicada para Serena (y probablemente no sea necesaria, ya que Serena ya se puede usar con cualquier IDE compatible con servidores MCP). Si existe demanda de una herramienta CLI como Claude Code para Serena, consideraremos desarrollarla.

La principal diferencia entre Serena y otros agentes basados en API es que también puede utilizarse como servidor MCP, por lo que no requiere una clave API y evita los costes de la API. Esta es una característica única de Serena.

Otros agentes de codificación basados en MCP

Existen otros servidores MCP diseñados para codificación, como DesktopCommander y codemcp . Sin embargo, hasta donde sabemos, ninguno ofrece herramientas de recuperación y edición de código semántico; se basan exclusivamente en el análisis de texto. Es la integración de los servidores de lenguaje y el MCP lo que hace a Serena único y tan potente para tareas de codificación complejas, especialmente en el contexto de bases de código extensas.

Incorporación y recuerdos

De forma predeterminada, Serena realizará un proceso de incorporación al iniciar un proyecto por primera vez. El objetivo es que Serena se familiarice con el proyecto y guarde recuerdos que pueda utilizar en futuras interacciones.

Las memorias son archivos almacenados en .serena/memories/ , en el directorio del proyecto, que el agente puede leer. Puede leerlas y modificarlas según sea necesario; también puede agregar nuevas manualmente. Todos los archivos del directorio .serena/memories/ son archivos de memoria.

Descubrimos que los recuerdos mejoran significativamente la experiencia del usuario con Serena. Serena recibe instrucciones para crear nuevos recuerdos cuando sea necesario.

Modos y contextos

El comportamiento y el conjunto de herramientas de Serena se pueden ajustar mediante contextos y modos . Esto permite un alto grado de personalización para adaptarse mejor a su flujo de trabajo y al entorno en el que opera Serena.

Contextos

Un contexto define el entorno general en el que opera Serena. Influye en el mensaje inicial del sistema y en el conjunto de herramientas disponibles. Un contexto se configura al iniciar Serena (p. ej., mediante las opciones de la CLI para un servidor MCP o en el script del agente) y no se puede modificar durante una sesión activa.

Serena viene con contextos predefinidos:

  • desktop-app : Adaptada para usar con aplicaciones de escritorio como Claude Desktop. Suele ser la opción predeterminada.

  • agent : Diseñado para escenarios donde Serena actúa como un agente más autónomo, por ejemplo, cuando se usa con Agno.

  • ide-assistant : optimizado para la integración en IDE como VSCode, Cursor o Cline, centrándose en la asistencia de codificación en el editor.

Debes elegir el contexto que mejor se adapte a tu integración.

Modos

Los modos refinan aún más el comportamiento de Serena para tareas específicas o estilos de interacción. Se pueden activar varios modos simultáneamente, lo que permite combinar sus efectos. Los modos influyen en el mensaje del sistema y también pueden modificar el conjunto de herramientas disponibles, excluyendo algunas.

Algunos ejemplos de modos integrados incluyen:

  • planning : Serena se centra en tareas de planificación y análisis.

  • editing : Optimiza Serena para tareas de modificación directa de código.

  • interactive : Adecuado para un estilo de interacción conversacional de ida y vuelta.

  • one-shot : configura Serena para tareas que deben completarse en una sola respuesta, a menudo se utiliza con planning para generar informes o planes iniciales.

  • no-onboarding : omite el proceso de incorporación inicial si no es necesario para una sesión en particular.

  • onboarding : (generalmente se activa automáticamente) Se centra en el proceso de incorporación del proyecto.

Los modos se pueden configurar al inicio (similar a los contextos), pero también se pueden cambiar dinámicamente durante una sesión. Puede indicarle al LLM que use la herramienta switch_modes para activar un conjunto diferente de modos (por ejemplo, "cambiar a los modos de planificación y de una sola sesión").

:warning: Compatibilidad de modos : Si bien se pueden combinar modos, algunos pueden ser semánticamente incompatibles (p. ej., interactive y one-shot ). Serena actualmente no impide combinaciones incompatibles; el usuario debe elegir la configuración de modo adecuada.

Personalización de contextos y modos

Puedes crear tus propios contextos y modos para adaptar Serena con precisión a tus necesidades:

  1. Añadir a tu clon de Serena : Crea nuevos archivos .yml en los directorios config/contexts/ o config/modes/ de tu repositorio local de Serena. Estos contextos/modos personalizados se registrarán automáticamente y estarán disponibles por su nombre de archivo (sin la extensión .yml ). También aparecerán en las listas de contextos/modos disponibles.

  2. Uso de archivos YAML externos : al iniciar Serena, puede proporcionar una ruta absoluta a un archivo .yml personalizado para un contexto o modo.

Un archivo YAML de contexto o modo generalmente define:

  • name : (opcional si se utiliza el nombre de archivo) El nombre del contexto/modo.

  • prompt : Una cadena que se incorporará al indicador del sistema de Serena.

  • description : (opcional) Una breve descripción.

  • excluded_tools : una lista de nombres de herramientas (cadenas) para deshabilitar cuando este contexto/modo está activo.

Esta personalización permite una profunda integración y adaptación de Serena a los requisitos específicos del proyecto o preferencias personales.

Combinación con otros servidores MCP

Al usar Serena a través de un cliente MCP, puede usarlo junto con otros servidores MCP. Sin embargo, tenga cuidado con las colisiones de nombres de herramientas. Consulte la información anterior.

Actualmente, existe una colisión con el popular servidor MCP del sistema de archivos. Dado que Serena también proporciona operaciones del sistema de archivos, probablemente no sea necesario habilitarlos simultáneamente.

Recomendaciones sobre el uso de Serena

Seguiremos recopilando las mejores prácticas a medida que la comunidad de Serena crece. A continuación, se presenta un breve resumen de lo que aprendimos al usar Serena internamente.

La mayoría de estas recomendaciones son válidas para cualquier agente de codificación, incluidos todos los agentes mencionados anteriormente.

¿Qué modelo elegir?

Para nuestra sorpresa, Serena pareció funcionar mejor con la versión no pensante de Claude 3.7 que con su versión pensante (aún no hemos hecho comparaciones exhaustivas con Gemini). La versión pensante tardaba más, presentaba más dificultades para usar las herramientas y, a menudo, simplemente escribía código sin leer suficiente contexto.

En nuestros experimentos iniciales, Gemini pareció funcionar muy bien. Lamentablemente, Gemini no es compatible con MCP (¿todavía?), por lo que la única forma de usarlo es mediante una clave API. Lo bueno es que Gemini es relativamente económico y admite contextos de gran longitud.

Incorporación

En la primera interacción, se le indica a Serena que realice la incorporación y escriba los primeros archivos de memoria. A veces (según el LLM), los archivos no se escriben en el disco. En ese caso, simplemente pídale a Serena que escriba las memorias.

En esta fase, Serena suele leer y escribir bastante texto, completando así el contexto. Recomendamos cambiar a otra conversación una vez realizada la incorporación para no quedarse sin tokens. La incorporación solo se realizará una vez, a menos que la active explícitamente.

Luego de la incorporación, te recomendamos que eches un vistazo rápido a las memorias y, si es necesario, las edites o agregues otras.

Antes de editar el código

Es mejor iniciar una tarea de generación de código desde un estado limpio de Git. Esto no solo facilitará la inspección de los cambios, sino que también permitirá que el propio modelo vea qué ha cambiado al llamar git diff y, por lo tanto, se corrija o continúe trabajando en una conversación de seguimiento si es necesario.

Importante : Dado que Serena escribirá en archivos usando los finales de línea nativos del sistema y podría querer ver la diferencia de Git, es importante establecer git config core.autocrlf en " true en Windows. Con git config core.autocrlf " en false en Windows, podrías obtener grandes diferencias debido únicamente a los finales de línea. Generalmente, es recomendable habilitar esta configuración de Git en Windows:

git config --global core.autocrlf true

Posibles problemas en la edición de código

En nuestra experiencia, los LLM son muy deficientes para contar, es decir, tienen problemas para insertar bloques de código en el lugar correcto. La mayoría de las operaciones de edición se pueden realizar a nivel simbólico, lo que permite solucionar este problema. Sin embargo, a veces, las inserciones a nivel de línea son útiles.

Se le indica a Serena que verifique dos veces los números de línea y cualquier bloque de código que editará, pero puede resultarle útil indicarle explícitamente cómo editar el código si surge algún problema.

Quedarse sin contexto

Para tareas largas y complejas, o en las que Serena ha leído mucho contenido, es posible que se alcance el límite de tokens de contexto. En ese caso, suele ser recomendable continuar en una nueva conversación. Serena cuenta con una herramienta dedicada a crear un resumen del estado actual del progreso y toda la información relevante para continuarlo. Puedes solicitar la creación de este resumen y guardarlo en una memoria. Después, en una nueva conversación, puedes pedirle a Serena que lea la memoria y continúe con la tarea. En nuestra experiencia, esto funcionó muy bien. La ventaja es que, al no tener que resumir en una sola sesión, Serena no suele perderse (a diferencia de otros agentes que resumen en segundo plano), y además se le indica que compruebe ocasionalmente si va por buen camino.

Además, a Serena se le indica que sea frugal con el contexto (por ejemplo, que no lea los cuerpos de los símbolos de código innecesariamente), pero descubrimos que Claude no siempre es muy bueno en ser frugal (Gemini parecía ser mejor en eso). Puedes indicarle explícitamente que no lea los cuerpos si sabes que no es necesario.

Control de ejecución de herramientas

Claude Desktop le preguntará antes de ejecutar una herramienta. Para la mayoría de las herramientas, puede simplemente hacer clic en "Permitir para este chat", especialmente si todos sus archivos están bajo control de versiones. Una excepción es la herramienta execute_shell_command ", donde podría querer inspeccionar cada llamada individualmente. Recomendamos revisar cada llamada a este comando y no habilitarlo para todo el chat.

Estructurando su base de código

Serena usa la estructura del código para buscar, leer y editar código. Esto significa que funcionará bien con código bien estructurado, pero podría fallar con código completamente desestructurado (como una clase-Dios con funciones enormes y no modulares). Las anotaciones de tipo también son muy útiles en este caso. Cuanto mejor sea tu código, mejor funcionará Serena. Por lo tanto, generalmente recomendamos escribir código bien estructurado, modular y tipado; no solo te ayudará a ti, sino también a tu IA.

Registro, análisis y pruebas

Serena no puede depurar (de momento, ningún asistente de programación puede hacerlo, según nuestro conocimiento). Esto significa que, para mejorar los resultados dentro de un bucle de agente , Serena necesita obtener información mediante la ejecución de pruebas, scripts, análisis de errores, etc. Suele ser muy útil incluir numerosos mensajes de registro con información explícita y contar con pruebas significativas. Estas últimas, en particular, suelen ayudar al agente a autocorregirse.

Generalmente recomendamos comenzar una tarea de edición desde un estado en el que se aprueben todas las pruebas y comprobaciones de pelusa.

Consejos generales

Descubrimos que suele ser buena idea dedicar tiempo a conceptualizar y planificar una tarea antes de implementarla, especialmente en tareas importantes. Esto ayuda a obtener mejores resultados y a aumentar la sensación de control y a mantenerse al tanto del proceso. Puedes crear un plan detallado en una sesión, donde Serena podría leer gran parte de tu código para crear el contexto, y luego continuar con la implementación en otra (posiblemente después de crear memorias adecuadas).

Solución de problemas

El soporte para servidores MCP en Claude Desktop y los diversos SDK de servidores MCP son desarrollos relativamente nuevos y pueden presentar inestabilidades.

La configuración de un servidor MCP puede variar según la plataforma y el cliente. Recomendamos usar siempre rutas absolutas, ya que las rutas relativas pueden ser fuente de errores. El servidor de idioma se ejecuta en un subproceso independiente y se llama con asyncio; a veces, un cliente puede provocar un bloqueo. Si la ventana de registro de Serena está activada y desaparece, sabrá qué ha ocurrido.

Es posible que algunos clientes (como Goose) no finalicen correctamente los servidores MCP. Busque procesos de Python colgados y finalícelos manualmente, si es necesario.

Registro de Serena

Para facilitar la resolución de problemas, hemos creado una pequeña utilidad de interfaz gráfica de usuario para el registro. Para la mayoría de los clientes, recomendamos habilitarla a través de la configuración del proyecto ( project.yml ) si surgen problemas. Muchos clientes también generan registros de MCP que pueden ayudar a identificar problemas.

Es posible que la interfaz gráfica de registro no funcione en todos los clientes ni en todos los sistemas. Actualmente, no funciona en macOS ni con extensiones de VSCode como Cline.

Expresiones de gratitud

Construimos Serena sobre múltiples tecnologías de código abierto existentes, siendo las más importantes:

  1. multilspy . Un contenedor de excelente diseño para servidores de lenguaje siguiendo el LSP. No era fácil de extender con la lógica simbólica que Serena requería, así que, en lugar de incorporarlo como dependencia, copiamos el código fuente y lo adaptamos a nuestras necesidades.

  2. SDK de Python MCP

  3. Agno y el agente-ui asociado, que utilizamos para permitir que Serena trabaje con cualquier modelo, más allá de los que admiten el MCP.

  4. Todos los servidores de idiomas que utilizamos a través de multilspy.

Sin estos proyectos, Serena no habría sido posible (o habría sido significativamente más difícil de construir).

Personalización de Serena

Es muy fácil ampliar la funcionalidad de IA de Serena con tus propias ideas. Simplemente implementa una nueva herramienta subclasificándola de serena.agent.Tool e implementa el método apply (no forma parte de la interfaz; consulta el comentario en Tool ). Por defecto, SerenaAgent tendrá acceso inmediato a ella.

Añadir compatibilidad con un nuevo idioma también es relativamente sencillo. ¡Estamos deseando ver qué aporta la comunidad! Para más información sobre cómo contribuir, consulta aquí .

Lista completa de herramientas

Aquí está la lista completa de las herramientas de Serena con una breve descripción (salida de uv run serena-list-tools ):

  • activate_project : Activa un proyecto por nombre.

  • check_onboarding_performed : Comprueba si ya se realizó la incorporación del proyecto.

  • create_text_file : crea/sobrescribe un archivo en el directorio del proyecto.

  • delete_lines : elimina un rango de líneas dentro de un archivo.

  • delete_memory : elimina una memoria del almacén de memoria específico del proyecto de Serena.

  • execute_shell_command : ejecuta un comando de shell.

  • find_referencing_code_snippets : busca fragmentos de código en los que se hace referencia al símbolo en la ubicación indicada.

  • find_referencing_symbols : busca símbolos que hacen referencia al símbolo en la ubicación dada (opcionalmente filtrado por tipo).

  • find_symbol : realiza una búsqueda global (o local) de símbolos con/que contengan un nombre/subcadena determinado (opcionalmente filtrado por tipo).

  • get_active_project : Obtiene el nombre del proyecto actualmente activo (si hay alguno) y enumera los proyectos existentes

  • get_current_config : imprime la configuración actual del agente, incluidos los modos activos, las herramientas y el contexto.

  • get_symbols_overview : obtiene una descripción general de los símbolos de nivel superior definidos en un archivo o directorio determinado.

  • initial_instructions : Obtiene las instrucciones iniciales del proyecto actual. Solo debe usarse en configuraciones donde no se puede configurar el indicador del sistema, por ejemplo, en clientes sin control, como Claude Desktop.

  • insert_after_symbol : inserta contenido después del final de la definición de un símbolo dado.

  • insert_at_line : inserta contenido en una línea determinada de un archivo.

  • insert_before_symbol : inserta contenido antes del comienzo de la definición de un símbolo dado.

  • list_dir : enumera archivos y directorios en el directorio dado (opcionalmente con recursión).

  • list_memories : enumera los recuerdos en el almacén de memoria específico del proyecto de Serena.

  • onboarding : realiza la onboarding (identificando la estructura del proyecto y las tareas esenciales, por ejemplo, para pruebas o construcción).

  • prepare_for_new_conversation : proporciona instrucciones para prepararse para una nueva conversación (para continuar con el contexto necesario).

  • read_file : lee un archivo dentro del directorio del proyecto.

  • read_memory : lee la memoria con el nombre dado desde el almacén de memoria específico del proyecto de Serena.

  • replace_lines : reemplaza un rango de líneas dentro de un archivo con contenido nuevo.

  • replace_symbol_body : reemplaza la definición completa de un símbolo.

  • restart_language_server : reinicia el servidor de idioma, puede ser necesario cuando se realizan ediciones que no se realizan a través de Serena.

  • search_for_pattern : realiza una búsqueda de un patrón en el proyecto.

  • summarize_changes : proporciona instrucciones para resumir los cambios realizados en el código base.

  • switch_modes : activa los modos proporcionando una lista de sus nombres

  • think_about_collected_information : Herramienta de pensamiento para reflexionar sobre la integridad de la información recopilada.

  • think_about_task_adherence : herramienta de pensamiento para determinar si el agente todavía está encaminado con la tarea actual.

  • think_about_whether_you_are_done : Herramienta de pensamiento para determinar si la tarea está realmente completada.

  • write_memory : escribe una memoria nombrada (para referencia futura) en el almacén de memoria específico del proyecto de Serena.

Available Tools

29 tools
activate_projectActivate ProjectB
Read-only

Activates the project with the given name or path.

ParametersJSON Schema
NameRequiredDescriptionDefault
projectYesThe name of a registered project to activate or a path to a project directory.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate readOnlyHint=true and destructiveHint=false, which the description does not contradict. The description adds minimal behavioral context by implying activation of a project, but it doesn't elaborate on effects like environment changes or permissions needed. With annotations covering safety, the description provides some value but not rich behavioral details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's function without unnecessary words. It is front-loaded and wastes no space, making it highly concise and well-structured for quick understanding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (activation operation), high schema coverage, annotations, and the presence of an output schema, the description is reasonably complete. It covers the basic action but could benefit from more context on outcomes or integration with sibling tools, though the structured data reduces the burden on the description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 100% description coverage, clearly documenting the 'project' parameter. The description adds no additional meaning beyond the schema, such as examples or constraints, but since the schema is comprehensive, a baseline score of 3 is appropriate as the description doesn't compensate unnecessarily.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('activates') and the resource ('the project with the given name or path'), making the purpose specific and understandable. However, it does not differentiate this tool from sibling tools like 'switch_modes' or 'get_current_config', which might relate to project state changes, so it doesn't fully distinguish from alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives, such as 'switch_modes' or 'get_current_config', nor does it mention prerequisites like needing a registered project. It lacks explicit when/when-not instructions or named alternatives, leaving usage context unclear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

check_onboarding_performedCheck Onboarding PerformedA
Read-only

Checks whether project onboarding was already performed. You should always call this tool before beginning to actually work on the project/after activating a project.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate readOnlyHint=true and destructiveHint=false, which the description aligns with by implying a non-destructive check. The description adds value by specifying the tool's role in workflow sequencing (before work/after activation), but doesn't provide additional behavioral details like error handling or output interpretation beyond what annotations cover.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences, front-loaded with the core purpose followed by usage guidelines. Every word serves a clear function, with no redundancy or unnecessary elaboration, making it highly efficient and easy to parse.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 0 parameters, annotations covering safety (read-only, non-destructive), and an output schema (implied by context signals), the description is reasonably complete. It explains what the tool does and when to use it, though it could benefit from hinting at the output's meaning (e.g., boolean result or status details) to fully compensate for lack of output schema explanation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters with 100% schema description coverage, so no parameter documentation is needed. The description doesn't mention parameters, which is appropriate. A baseline of 4 is applied since no parameters exist, and the description focuses correctly on the tool's purpose and usage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Checks whether project onboarding was already performed.' It specifies the verb ('checks') and resource ('project onboarding'), making the intent unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'onboarding' or 'activate_project', which might have overlapping contexts.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidelines: 'You should always call this tool before beginning to actually work on the project/after activating a project.' This gives clear timing and context for when to use it, including a reference to the sibling tool 'activate_project' as a related action.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

create_text_fileCreate Text FileA
Destructive

Write a new file or overwrite an existing file. Returns a message indicating success or failure.

ParametersJSON Schema
NameRequiredDescriptionDefault
relative_pathYesThe relative path to the file to create.
contentYesThe (appropriately encoded) content to write to the file.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint=true and readOnlyHint=false, but the description adds valuable context by specifying that it can 'overwrite an existing file' and returns 'success or failure' messages. This clarifies the destructive nature beyond the annotation and provides outcome expectations, though it doesn't mention permissions, rate limits, or file encoding details.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description consists of two tightly focused sentences that efficiently convey the core functionality and outcome. Every word serves a purpose with zero redundancy, and the information is front-loaded with the primary action stated immediately.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the destructive nature indicated by annotations, the presence of an output schema, and 100% parameter coverage, the description provides adequate context. It covers the tool's primary behavior and outcome expectations, though it could benefit from mentioning encoding requirements or error scenarios for a more complete picture.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the input schema fully documents both parameters. The description doesn't add any parameter-specific information beyond what's in the schema, so it meets the baseline score of 3. No additional semantic context is provided for 'relative_path' or 'content' parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Write a new file or overwrite an existing file') and resource ('file'), distinguishing it from sibling tools like 'read_file' or 'replace_content'. It precisely communicates both creation and overwrite capabilities in a single concise statement.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for file creation/overwriting but provides no explicit guidance on when to use this tool versus alternatives like 'replace_content' or 'write_memory'. It mentions the tool's behavior but doesn't specify scenarios where it's preferred over other file manipulation tools in the sibling list.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

delete_memoryDelete MemoryA
Destructive

Delete a memory file. Should only happen if a user asks for it explicitly, for example by saying that the information retrieved from a memory file is no longer correct or no longer relevant for the project.

ParametersJSON Schema
NameRequiredDescriptionDefault
memory_file_nameYes

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint=true and readOnlyHint=false, which cover the core safety profile. The description adds valuable context beyond this by emphasizing the need for explicit user consent and providing rationale examples, which helps the agent understand the gravity of the operation. It doesn't detail error conditions or output behavior, but with annotations present, this is sufficient.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences that are front-loaded with the core action and immediately followed by critical usage guidelines. Every word serves a purpose, with no redundancy or fluff, making it highly efficient and easy to parse for an AI agent.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's destructive nature, the description effectively complements the annotations by stressing user consent and providing examples. With an output schema present, it doesn't need to explain return values. The combination of clear purpose, strong guidelines, and annotations makes this description sufficiently complete for safe agent use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0% description coverage, with only one parameter ('memory_file_name') documented structurally. The description doesn't add any parameter-specific information, such as format examples or constraints. However, with a single parameter and the tool's clear purpose, the baseline of 3 is appropriate as the schema alone provides minimal but adequate coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Delete') and resource ('a memory file'), making the purpose immediately understandable. It distinguishes from sibling tools like 'edit_memory', 'read_memory', and 'write_memory' by specifying deletion rather than modification or retrieval. However, it doesn't explicitly contrast with 'list_memories' or other file-related tools beyond the verb itself.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool: 'only if a user asks for it explicitly', with concrete examples ('information retrieved from a memory file is no longer correct or no longer relevant for the project'). This clearly defines the appropriate context and helps the agent avoid misuse, especially given the destructive nature implied by the tool name.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

edit_memoryEdit MemoryA
Destructive

Replaces content matching a regular expression in a memory.

ParametersJSON Schema
NameRequiredDescriptionDefault
memory_file_nameYesThe name of the memory.
needleYesThe string or regex pattern to search for. If `mode` is "literal", this string will be matched exactly. If `mode` is "regex", this string will be treated as a regular expression (syntax of Python's `re` module, with flags DOTALL and MULTILINE enabled).
replYesThe replacement string (verbatim).
modeYesEither "literal" or "regex", specifying how the `needle` parameter is to be interpreted.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false and destructiveHint=true, indicating this is a mutation tool with destructive potential. The description adds useful context about regex matching behavior (Python re module with DOTALL/MULTILINE flags) and the replacement being verbatim, which goes beyond annotations. However, it doesn't mention error conditions, side effects, or what happens when no match is found.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads the core functionality ('Replaces content matching a regular expression in a memory'). Every word earns its place with no redundancy or unnecessary elaboration.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (regex editing with destructive potential), the description provides adequate context when combined with rich annotations and a complete input schema. However, it could benefit from mentioning the existence of an output schema (which handles return values) and providing more behavioral context about edge cases. The combination of description, annotations, and schema is mostly complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, all parameters are well-documented in the schema itself. The description doesn't add significant semantic information beyond what's already in the parameter descriptions, which thoroughly explain memory_file_name, needle (with mode-specific behavior), repl, and mode. The baseline of 3 is appropriate when the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Replaces content') on a specific resource ('in a memory') using a specific method ('matching a regular expression'). It distinguishes from siblings like 'replace_content' (general file replacement) and 'write_memory' (full overwrite) by specifying regex-based partial editing of memory files.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for regex-based editing of memory content, but doesn't explicitly state when to use this vs alternatives like 'replace_content' for non-memory files or 'write_memory' for complete overwrites. It provides clear context about the operation type but lacks explicit exclusion guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

execute_shell_commandExecute Shell CommandA
Destructive

Execute a shell command and return its output. If there is a memory about suggested commands, read that first. Never execute unsafe shell commands! IMPORTANT: Do not use this tool to start

  • long-running processes (e.g. servers) that are not intended to terminate quickly,

  • processes that require user interaction. Returns a JSON object containing the command's stdout and optionally stderr output.

ParametersJSON Schema
NameRequiredDescriptionDefault
commandYesThe shell command to execute.
cwdNoThe working directory to execute the command in. If None, the project root will be used.
capture_stderrNoWhether to capture and return stderr output.
max_answer_charsNoIf the output is longer than this number of characters, no content will be returned. -1 means using the default value, don't adjust unless there is no other way to get the content required for the task.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint=true and readOnlyHint=false, but the description adds valuable behavioral context beyond this: it warns against unsafe commands, specifies output truncation behavior via max_answer_chars, mentions checking memory first, and describes the JSON return structure. This provides important safety and operational guidance that annotations alone don't cover.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized and front-loaded with the core purpose, followed by important warnings and return format details. While some sentences could be more concise (e.g., the warning about long-running processes is slightly verbose), overall it's efficient with each sentence serving a clear purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (destructive shell command execution), rich annotations (destructiveHint=true), complete schema coverage, and existence of an output schema, the description provides excellent contextual completeness. It covers safety warnings, usage constraints, memory integration, and output behavior, making it fully adequate for an AI agent to understand when and how to use this tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the input schema already fully documents all 4 parameters. The description doesn't add any parameter-specific semantics beyond what's in the schema descriptions, so it meets the baseline expectation without providing additional value about parameter usage or interactions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('execute a shell command and return its output') and distinguishes it from siblings by focusing on command execution rather than file operations, memory management, or project configuration. It goes beyond just restating the name/title by specifying the return format and behavioral constraints.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when NOT to use this tool (for long-running processes or processes requiring user interaction) and references checking memory for suggested commands first. However, it doesn't explicitly name alternative tools for those excluded use cases or differentiate from similar tools like list_dir for directory operations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

find_fileFind FileA
Read-only

Finds non-gitignored files matching the given file mask within the given relative path. Returns a JSON object with the list of matching files.

ParametersJSON Schema
NameRequiredDescriptionDefault
file_maskYesThe filename or file mask (using the wildcards * or ?) to search for.
relative_pathYesThe relative path to the directory to search in; pass "." to scan the project root.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds useful behavioral context by specifying 'non-gitignored files' (exclusion behavior) and the return format ('JSON object with the list of matching files'), but does not mention potential limitations like recursion depth or performance implications.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads the core functionality and includes essential details (exclusion of gitignored files, return format) without any wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity, rich annotations (readOnlyHint, destructiveHint), 100% schema coverage, and presence of an output schema, the description is complete enough. It covers purpose, key behavioral trait (non-gitignored), and return format, leaving detailed parameter and output documentation to the structured fields.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with both parameters well-documented in the schema. The description adds minimal value beyond the schema by implying the search scope and exclusion of gitignored files, but does not provide additional syntax or format details for the parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Finds'), resource ('non-gitignored files'), and scope ('matching the given file mask within the given relative path'), distinguishing it from siblings like 'list_dir' (which lists directory contents) and 'search_for_pattern' (which searches file content).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool (searching for files by name/mask, excluding gitignored files), but does not explicitly state when not to use it or name alternatives like 'list_dir' for directory listing or 'search_for_pattern' for content search.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

find_referencing_symbolsFind Referencing SymbolsA
Read-only

Finds references to the symbol at the given name_path. The result will contain metadata about the referencing symbols as well as a short code snippet around the reference. Returns a list of JSON objects with the symbols referencing the requested symbol.

ParametersJSON Schema
NameRequiredDescriptionDefault
name_pathYesFor finding the symbol to find references for, same logic as in the `find_symbol` tool.
relative_pathYesThe relative path to the file containing the symbol for which to find references. Note that here you can't pass a directory but must pass a file.
include_kindsNoSame as in the `find_symbol` tool.
exclude_kindsNoSame as in the `find_symbol` tool.
max_answer_charsNoSame as in the `find_symbol` tool.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds useful behavioral context beyond annotations by specifying what the result contains (metadata about referencing symbols and short code snippets) and that it returns a list of JSON objects. However, it doesn't mention potential limitations like performance impacts or result size constraints.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is efficiently structured in two sentences with zero waste. The first sentence states the core functionality and result format, while the second clarifies the return type. Every word contributes to understanding the tool's purpose and output.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of annotations (readOnlyHint, destructiveHint), 100% schema coverage, and an output schema (implied by 'Returns a list of JSON objects'), the description provides complete contextual information. It adequately explains what the tool does, what it returns, and references sibling tools where appropriate, making it sufficient for agent understanding.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the input schema already documents all 5 parameters thoroughly, including references to the 'find_symbol' tool for parameter behavior. The description doesn't add significant semantic information beyond what's in the schema, maintaining the baseline score of 3 for adequate but not enhanced parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with a specific verb ('Finds references') and resource ('the symbol at the given name_path'), and distinguishes it from sibling tools by specifying it returns referencing symbols rather than finding symbols themselves. It explicitly mentions what the result contains (metadata and code snippets), making the purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context by mentioning the tool finds references to a symbol, suggesting it should be used when you need to know where a symbol is referenced. However, it doesn't explicitly state when to use this tool versus alternatives like 'find_symbol' or provide exclusion criteria, though the parameter descriptions reference 'find_symbol' for some parameters.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

find_symbolFind SymbolA
Read-only

Retrieves information on all symbols/code entities (classes, methods, etc.) based on the given name path pattern. The returned symbol information can be used for edits or further queries. Specify depth > 0 to also retrieve children/descendants (e.g., methods of a class).

A name path is a path in the symbol tree within a source file. For example, the method my_method defined in class MyClass would have the name path MyClass/my_method. If a symbol is overloaded (e.g., in Java), a 0-based index is appended (e.g. "MyClass/my_method[0]") to uniquely identify it.

To search for a symbol, you provide a name path pattern that is used to match against name paths. It can be

  • a simple name (e.g. "method"), which will match any symbol with that name

  • a relative path like "class/method", which will match any symbol with that name path suffix

  • an absolute name path "/class/method" (absolute name path), which requires an exact match of the full name path within the source file. Append an index [i] to match a specific overload only, e.g. "MyClass/my_method[1]". Returns a list of symbols (with locations) matching the name.

ParametersJSON Schema
NameRequiredDescriptionDefault
name_path_patternYesThe name path matching pattern (see above).
depthNoDepth up to which descendants shall be retrieved (e.g. use 1 to also retrieve immediate children; for the case where the symbol is a class, this will return its methods). Default 0.
relative_pathNoOptional. Restrict search to this file or directory. If None, searches entire codebase. If a directory is passed, the search will be restricted to the files in that directory. If a file is passed, the search will be restricted to that file. If you have some knowledge about the codebase, you should use this parameter, as it will significantly speed up the search as well as reduce the number of results.
include_bodyNoIf True, include the symbol's source code. Use judiciously.
include_kindsNoOptional. List of LSP symbol kind integers to include. (e.g., 5 for Class, 12 for Function). Valid kinds: 1=file, 2=module, 3=namespace, 4=package, 5=class, 6=method, 7=property, 8=field, 9=constructor, 10=enum, 11=interface, 12=function, 13=variable, 14=constant, 15=string, 16=number, 17=boolean, 18=array, 19=object, 20=key, 21=null, 22=enum member, 23=struct, 24=event, 25=operator, 26=type parameter. If not provided, all kinds are included.
exclude_kindsNoOptional. List of LSP symbol kind integers to exclude. Takes precedence over `include_kinds`. If not provided, no kinds are excluded.
substring_matchingNoIf True, use substring matching for the last element of the pattern, such that "Foo/get" would match "Foo/getValue" and "Foo/getData".
max_answer_charsNoMax characters for the JSON result. If exceeded, no content is returned. -1 means the default value from the config will be used.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.2/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, so the agent knows this is a safe read operation. The description adds valuable behavioral context beyond annotations: it explains that results can be used for edits, describes the matching logic (simple name, relative path, absolute path), mentions overload handling with indices, and notes performance considerations (using relative_path speeds up search). It does not contradict annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured and front-loaded with the core purpose, followed by detailed explanations of name paths and patterns. While comprehensive, it is appropriately sized for a complex tool with many parameters. Some sentences could be more concise (e.g., the name path explanation is lengthy), but overall it avoids unnecessary repetition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (8 parameters, 100% schema coverage, annotations, and an output schema), the description is complete. It covers purpose, usage examples, behavioral nuances (like overload handling and performance tips), and does not need to explain return values since an output schema exists. It adequately complements the structured data without gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all 8 parameters thoroughly. The description adds some semantic context for name_path_pattern (explaining patterns and examples) and depth (linking it to retrieving children), but most parameter details are already in the schema. This meets the baseline of 3 for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('retrieves information on all symbols/code entities') and distinguishes it from siblings by focusing on symbol lookup rather than file operations (find_file), pattern searching (search_for_pattern), or symbol editing (rename_symbol, replace_symbol_body). It explicitly mentions what the returned information can be used for ('for edits or further queries'), which helps differentiate its role.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool (e.g., 'Specify `depth > 0` to also retrieve children/descendants') and implies alternatives through sibling tool names like find_file or search_for_pattern, but it does not explicitly state when not to use it or name specific alternatives. The guidance on using the relative_path parameter for speed and reduced results offers practical usage advice.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_current_configGet Current ConfigA
Read-only

Print the current configuration of the agent, including the active and available projects, tools, contexts, and modes.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, covering safety. The description adds valuable context by specifying what configuration components are included (projects, tools, contexts, modes), which isn't inferable from annotations alone. However, it doesn't mention output format details or potential limitations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads the core action ('Print the current configuration') and then enumerates included components. Every word adds value with zero redundancy or fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (0 parameters, read-only, non-destructive), the description fully covers its purpose and scope. With annotations providing safety context and an output schema existing (so return values needn't be described), the description is complete for this low-complexity tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0 parameters and 100% schema description coverage, the baseline is 4. The description appropriately doesn't discuss parameters since none exist, avoiding unnecessary detail while clearly indicating the tool operates without inputs.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Print') and the exact resource ('current configuration of the agent'), listing all included components (active/available projects, tools, contexts, modes). It distinguishes itself from siblings like 'get_symbols_overview' or 'list_memories' by focusing on overall agent configuration rather than specific data subsets.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage when needing to inspect the agent's configuration state, but provides no explicit guidance on when to use this versus alternatives like 'check_onboarding_performed' or 'switch_modes'. It doesn't specify prerequisites, exclusions, or comparative contexts with sibling tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_symbols_overviewGet Symbols OverviewA
Read-only

Use this tool to get a high-level understanding of the code symbols in a file. This should be the first tool to call when you want to understand a new file, unless you already know what you are looking for. Returns a JSON object containing info about top-level symbols in the file.

ParametersJSON Schema
NameRequiredDescriptionDefault
relative_pathYesThe relative path to the file to get the overview of.
depthNoDepth up to which descendants of top-level symbols shall be retrieved (e.g. 1 retrieves immediate children). Default 0.
max_answer_charsNoIf the overview is longer than this number of characters, no content will be returned. -1 means the default value from the config will be used. Don't adjust unless there is really no other way to get the content required for the task.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds valuable context beyond this by specifying that it returns 'a JSON object containing info about top-level symbols in the file,' which clarifies the output format. However, it doesn't mention potential limitations like rate limits or error conditions, leaving some behavioral aspects uncovered.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is efficiently structured in three sentences: the first states the purpose, the second provides usage guidelines, and the third describes the return format. Each sentence adds essential value without redundancy, making it front-loaded and appropriately concise for the tool's complexity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity, rich annotations (readOnlyHint, destructiveHint), 100% schema coverage, and the presence of an output schema, the description is complete enough. It covers purpose, usage context, and output format, leaving detailed parameter and return value documentation to the structured fields, which is appropriate for this setup.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all three parameters. The description adds no additional parameter semantics beyond what's in the schema (e.g., it doesn't explain 'relative_path' context or 'depth' implications further). This meets the baseline of 3 since the schema carries the full burden, but the description doesn't compensate with extra insights.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('get a high-level understanding of the code symbols in a file') and resource ('file'), distinguishing it from sibling tools like 'find_symbol' or 'read_file' by focusing on symbol overview rather than searching or raw content. It explicitly positions this as the first tool for understanding new files, making its purpose distinct and well-defined.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool ('first tool to call when you want to understand a new file') and when not to ('unless you already know what you are looking for'), effectively differentiating it from alternatives like 'find_symbol' for targeted searches. This clear contextual advice helps the agent choose appropriately among siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

initial_instructionsInitial InstructionsA
Read-only

Provides the 'Serena Instructions Manual', which contains essential information on how to use the Serena toolbox. IMPORTANT: If you have not yet read the manual, call this tool immediately after you are given your task by the user, as it will critically inform you!.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds that it provides 'essential information' and is 'critical' to inform the agent, which adds context about importance. However, it doesn't specify format, length, or structure of the manual content beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately concise with two sentences that each serve distinct purposes: stating what the tool provides and giving critical usage instructions. It's front-loaded with the core purpose, though the second sentence could be slightly more streamlined.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 0 parameters, annotations covering safety, and an output schema exists, the description provides adequate context about purpose and critical timing. It doesn't need to explain return values since output schema exists, but could optionally hint at manual content format for slightly better completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0 parameters and 100% schema description coverage, the baseline is 4. The description appropriately doesn't discuss parameters since none exist, focusing instead on the tool's purpose and usage timing.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool 'provides the Serena Instructions Manual' which is a specific resource, though it doesn't specify the exact content or format of the manual. It distinguishes itself from siblings by being the only tool focused on providing essential instructions rather than performing project operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidance: 'If you have not yet read the manual, call this tool immediately after you are given your task by the user, as it will critically inform you!' This clearly indicates when to use it (immediately after task assignment if manual not read) and implies it's foundational before using other tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

insert_after_symbolInsert After SymbolA
Destructive

Inserts the given body/content after the end of the definition of the given symbol (via the symbol's location). A typical use case is to insert a new class, function, method, field or variable assignment.

ParametersJSON Schema
NameRequiredDescriptionDefault
name_pathYesName path of the symbol after which to insert content (definitions in the `find_symbol` tool apply).
relative_pathYesThe relative path to the file containing the symbol.
bodyYesThe body/content to be inserted. The inserted code shall begin with the next line after the symbol.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint=true and readOnlyHint=false, but the description adds valuable behavioral context: it specifies that insertion occurs 'after the end of the definition' and that 'the inserted code shall begin with the next line after the symbol.' This clarifies the exact positioning behavior beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is perfectly concise with two sentences: the first states the core functionality, the second provides a typical use case. Every word earns its place, and the most important information (what the tool does) is front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the presence of both annotations (destructiveHint=true, readOnlyHint=false) and an output schema (implied by context signals), the description provides complete contextual information. It covers the tool's purpose, typical usage, and behavioral specifics without needing to explain return values or safety characteristics that are already documented elsewhere.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, all parameters are already documented in the input schema. The description adds some context by mentioning 'symbol's location' and referencing 'find_symbol' for name_path, but doesn't provide significant additional semantic meaning beyond what's in the schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('inserts') and target ('after the end of the definition of the given symbol'), with explicit mention of the content being inserted ('body/content'). It distinguishes from sibling 'insert_before_symbol' by specifying 'after' positioning, and from 'replace_symbol_body' by indicating insertion rather than replacement.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool ('to insert a new class, function, method, field or variable assignment') and references the 'find_symbol' tool for determining symbol locations. However, it doesn't explicitly state when NOT to use it or directly compare with alternatives like 'insert_before_symbol' or 'replace_content'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

insert_before_symbolInsert Before SymbolA
Destructive

Inserts the given content before the beginning of the definition of the given symbol (via the symbol's location). A typical use case is to insert a new class, function, method, field or variable assignment; or a new import statement before the first symbol in the file.

ParametersJSON Schema
NameRequiredDescriptionDefault
name_pathYesName path of the symbol before which to insert content (definitions in the `find_symbol` tool apply).
relative_pathYesThe relative path to the file containing the symbol.
bodyYesThe body/content to be inserted before the line in which the referenced symbol is defined.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate destructiveHint=true and readOnlyHint=false, which the description aligns with by describing an insertion operation that modifies files. The description adds valuable context beyond annotations by specifying that insertion occurs 'before the beginning of the definition' and via 'the symbol's location', and mentions typical use cases, which helps the agent understand the tool's behavior in practical scenarios.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose in the first sentence, followed by a second sentence providing typical use cases. Both sentences earn their place by clarifying scope and practical applications without redundancy or unnecessary details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (file modification with symbol-based positioning), the description provides sufficient context alongside annotations (destructive, not read-only) and a complete input schema. With an output schema present, the description does not need to explain return values, making it complete for agent usage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, providing clear documentation for all three parameters (name_path, relative_path, body). The description adds minimal semantic value beyond the schema, only implying that 'body' is content to insert and referencing 'find_symbol' for name_path definitions. This meets the baseline of 3 when schema coverage is high.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('inserts') and resource ('content before the beginning of the definition of the given symbol'), with specific examples of typical use cases (new class, function, method, field, variable assignment, or import statement). It distinguishes from sibling 'insert_after_symbol' by specifying 'before' rather than 'after'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool ('to insert a new class, function, method, field or variable assignment; or a new import statement before the first symbol in the file'), but does not explicitly state when not to use it or name alternatives beyond the implied sibling 'insert_after_symbol'. It lacks explicit exclusions or prerequisites.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_dirList DirA
Read-only

Lists files and directories in the given directory (optionally with recursion). Returns a JSON object with the names of directories and files within the given directory.

ParametersJSON Schema
NameRequiredDescriptionDefault
relative_pathYesThe relative path to the directory to list; pass "." to scan the project root.
recursiveYesWhether to scan subdirectories recursively.
skip_ignored_filesNoWhether to skip files and directories that are ignored.
max_answer_charsNoIf the output is longer than this number of characters, no content will be returned. -1 means the default value from the config will be used. Don't adjust unless there is really no other way to get the content required for the task.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.8/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds value by specifying the return format ('JSON object with names of directories and files') and hinting at recursion behavior, but does not disclose additional traits like rate limits, auth needs, or error conditions beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose in the first sentence and adds useful details in the second. Both sentences earn their place by clarifying functionality and output format without redundancy or unnecessary elaboration, making it efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity, rich annotations (readOnlyHint, destructiveHint), and the presence of an output schema, the description is largely complete. It covers purpose, optional recursion, and return format, though it could benefit from more explicit usage guidelines or edge-case handling to be fully comprehensive.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so parameters are fully documented in the schema. The description adds minimal semantics by mentioning recursion and the return format, but does not provide extra details on parameter usage or interactions beyond what the schema already covers, aligning with the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Lists') and resource ('files and directories'), specifies the scope ('in the given directory'), and mentions an optional feature ('with recursion'). It distinguishes itself from sibling tools like 'find_file' or 'search_for_pattern' by focusing on directory listing rather than searching or filtering.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage for directory listing but does not explicitly state when to use this tool versus alternatives like 'find_file' or 'search_for_pattern'. It mentions recursion as an option but lacks guidance on scenarios where recursion is preferred or when to avoid it, leaving usage context somewhat implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

list_memoriesList MemoriesA
Read-only

List available memories. Any memory can be read using the read_memory tool.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.9/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, so the agent knows this is a safe read operation. The description adds no behavioral traits beyond this, such as pagination, sorting, or access constraints, relying entirely on annotations for safety disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise with two sentences that are front-loaded and waste-free. Every word contributes to understanding the tool's purpose and usage, making it efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's low complexity (0 parameters, read-only, non-destructive) and the presence of annotations and an output schema, the description is complete enough for basic use. It could benefit from more detail on output format or limitations, but the essentials are covered.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0 parameters and 100% schema description coverage, the schema fully documents the lack of inputs. The description doesn't need to add parameter details, and its mention of 'available memories' implies no filtering, which aligns with the empty schema. Baseline is 4 for zero parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with a specific verb ('List') and resource ('memories'), making it immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'read_memory' beyond mentioning it as a follow-up action, missing direct comparison.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context by stating that listed memories can be read with 'read_memory', implying usage as a precursor to that tool. It doesn't specify when not to use it or alternatives, but the guidance is sufficient for basic navigation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

onboardingOnboardingA
Read-only

Call this tool if onboarding was not performed yet. You will call this tool at most once per conversation. Returns instructions on how to create the onboarding information.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds context about the one-time-per-conversation constraint and that it returns instructions, which are useful behavioral details beyond the annotations. However, it doesn't describe error handling or what happens if called multiple times.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is highly concise and well-structured with two sentences: the first states when to call it, and the second specifies the call frequency and return value. Every sentence adds essential information without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 0 parameters, annotations covering safety, and an output schema (implied by context signals), the description is mostly complete. It covers purpose, usage guidelines, and behavioral constraints. However, it could briefly mention what the instructions entail or link to sibling tools for more context, but the output schema likely handles return values.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description appropriately doesn't discuss parameters, focusing instead on usage context. A baseline of 4 is applied since there are no parameters to document.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: to be called when onboarding hasn't been performed yet, and it returns instructions for creating onboarding information. It specifies the verb 'call' and the resource 'onboarding', but doesn't explicitly differentiate from sibling tools like 'check_onboarding_performed' or 'initial_instructions' beyond the conditional trigger.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidelines: 'Call this tool if onboarding was not performed yet' and 'You will call this tool at most once per conversation.' This clearly defines when to use it (onboarding not done) and includes a usage constraint (once per conversation), though it doesn't name specific alternatives among siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

prepare_for_new_conversationPrepare For New ConversationB
Read-only

Instructions for preparing for a new conversation. This tool should only be called on explicit user request.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, so the agent knows this is a safe, non-destructive operation. The description adds no behavioral context beyond what annotations provide, such as what 'preparing' entails or any side effects. However, it doesn't contradict annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two short sentences with zero wasted words. It's appropriately sized and front-loaded, though the first sentence is uninformative. Every sentence serves a purpose: the first states the tool's name, and the second provides critical usage guidance.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has zero parameters, annotations covering safety, and an output schema (which means return values are documented elsewhere), the description is minimally adequate. However, it fails to explain what 'preparing for a new conversation' actually means or what the tool does, leaving a significant gap in understanding its purpose.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has zero parameters, and schema description coverage is 100%. With no parameters to document, the description doesn't need to compensate for any gaps. The baseline for zero parameters is 4, as there's nothing to explain beyond the empty schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Instructions for preparing for a new conversation' is a tautology that restates the tool's name/title without specifying what the tool actually does. It lacks a clear verb+resource combination and doesn't distinguish this tool from its many siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states 'This tool should only be called on explicit user request,' providing clear when-to-use guidance. This is a strong, unambiguous usage rule that helps the agent avoid inappropriate invocations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

read_fileRead FileA
Read-only

Reads the given file or a chunk of it. Generally, symbolic operations like find_symbol or find_referencing_symbols should be preferred if you know which symbols you are looking for. Returns the full text of the file at the given relative path.

ParametersJSON Schema
NameRequiredDescriptionDefault
relative_pathYesThe relative path to the file to read.
start_lineNoThe 0-based index of the first line to be retrieved.
end_lineNoThe 0-based index of the last line to be retrieved (inclusive). If None, read until the end of the file.
max_answer_charsNoIf the file (chunk) is longer than this number of characters, no content will be returned. Don't adjust unless there is really no other way to get the content required for the task.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating a safe read operation. The description adds valuable context beyond this: it explains that it can read 'a chunk' of a file (via start_line/end_line parameters) and warns about the max_answer_chars constraint ('no content will be returned' if exceeded). This enhances behavioral understanding without contradicting annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is efficiently structured in two sentences: the first states the core functionality and preferred alternatives, the second clarifies the return value. Every sentence serves a clear purpose with zero wasted words, making it easy to parse and understand quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (4 parameters, 1 required), 100% schema coverage, annotations covering safety, and an output schema (implied by 'Returns...'), the description is complete. It covers purpose, guidelines, and key behavioral aspects without needing to repeat schema details or explain return values extensively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema fully documents all four parameters. The description mentions 'chunk' reading and the max_answer_chars behavior, but these details are already covered in the schema descriptions for start_line, end_line, and max_answer_chars. It adds minimal semantic value beyond what the structured schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Reads') and resource ('the given file or a chunk of it'), distinguishing it from sibling tools like find_symbol or find_referencing_symbols. It explicitly mentions what it returns ('full text of the file at the given relative path'), making the purpose unambiguous and well-defined.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use alternatives: 'Generally, symbolic operations like find_symbol or find_referencing_symbols should be preferred if you know which symbols you are looking for.' This clearly indicates when not to use this tool and names specific sibling alternatives, offering strong contextual direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

read_memoryRead MemoryA
Read-only

Read the content of a memory file. This tool should only be used if the information is relevant to the current task. You can infer whether the information is relevant from the memory file name. You should not read the same memory file multiple times in the same conversation.

ParametersJSON Schema
NameRequiredDescriptionDefault
memory_file_nameYes
max_answer_charsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, indicating this is a safe read operation. The description adds valuable behavioral context beyond annotations: it specifies relevance criteria (based on file name) and a usage constraint (no repeated reads in same conversation). However, it doesn't disclose other potential behaviors like error handling, response format, or performance characteristics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is efficiently structured in three sentences: the first states the core purpose, the second provides usage criteria, and the third adds a behavioral constraint. Every sentence adds value without redundancy, and it's front-loaded with the essential action. No wasted words or unnecessary elaboration.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (a read operation with relevance filtering), annotations cover safety (read-only, non-destructive), and an output schema exists (so return values needn't be described), the description is reasonably complete. It adds useful context like relevance criteria and usage limits, though it lacks parameter explanations and doesn't fully address sibling tool differentiation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the schema provides no parameter documentation. The description doesn't explain either parameter's semantics—it mentions 'memory file name' but doesn't clarify its format or source, and omits 'max_answer_chars' entirely. Since parameters are few (2) and one has a default, the baseline is 3, but the description fails to compensate for the coverage gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Read') and resource ('content of a memory file'), making the purpose unambiguous. It distinguishes this tool from siblings like 'list_memories' (which lists files) and 'write_memory' (which writes content). However, it doesn't explicitly contrast with 'read_file' (which reads general files), leaving some sibling differentiation incomplete.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool ('if the information is relevant to the current task') and when not to use it ('should not read the same memory file multiple times in the same conversation'). It also implies alternatives by referencing the memory file name for relevance inference, though it doesn't name specific sibling tools like 'list_memories' for discovery.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

rename_symbolRename SymbolA
Destructive

Renames the symbol with the given name_path to new_name throughout the entire codebase. Note: for languages with method overloading, like Java, name_path may have to include a method's signature to uniquely identify a method. Returns result summary indicating success or failure.

ParametersJSON Schema
NameRequiredDescriptionDefault
name_pathYesName path of the symbol to rename (definitions in the `find_symbol` tool apply).
relative_pathYesThe relative path to the file containing the symbol to rename.
new_nameYesThe new name for the symbol.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already indicate destructiveHint=true and readOnlyHint=false, but the description adds valuable context: it specifies the scope ('throughout the entire codebase'), mentions language-specific considerations (Java method overloading), and describes the return format ('result summary indicating success or failure'). This goes beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is perfectly sized at three sentences, front-loaded with the core purpose, followed by important implementation notes and return value information. Every sentence earns its place with no wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the destructive nature (annotations), 3 parameters with full schema coverage, and the existence of an output schema, the description provides complete context. It covers purpose, scope, language considerations, and return format without needing to explain parameters or output details already documented elsewhere.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the schema already documents all three parameters thoroughly. The description adds minimal extra context: it references 'find_symbol' tool for name_path definitions and mentions method signatures for overloading, but doesn't provide significant additional parameter semantics beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('renames') and resource ('symbol with the given name_path'), specifying scope ('throughout the entire codebase'). It distinguishes from siblings like 'replace_symbol_body' by focusing on renaming rather than content replacement.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool (renaming symbols across codebases) and includes a note about method overloading in languages like Java. However, it doesn't explicitly state when NOT to use it or name specific alternatives among siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

replace_contentReplace ContentA
Destructive

Replaces one or more occurrences of a given pattern in a file with new content.

This is the preferred way to replace content in a file whenever the symbol-level tools are not appropriate.

VERY IMPORTANT: The "regex" mode allows very large sections of code to be replaced without fully quoting them! Use a regex of the form "beginning.*?end-of-text-to-be-replaced" to be faster and more economical! ALWAYS try to use wildcards to avoid specifying the exact content to be replaced, especially if it spans several lines. Note that you cannot make mistakes, because if the regex should match multiple occurrences while you disabled allow_multiple_occurrences, an error will be returned, and you can retry with a revised regex. Therefore, using regex mode with suitable wildcards is usually the best choice!.

ParametersJSON Schema
NameRequiredDescriptionDefault
relative_pathYesThe relative path to the file.
needleYesThe string or regex pattern to search for. If `mode` is "literal", this string will be matched exactly. If `mode` is "regex", this string will be treated as a regular expression (syntax of Python's `re` module, with flags DOTALL and MULTILINE enabled).
replYesThe replacement string (verbatim). If mode is "regex", the string can contain backreferences to matched groups in the needle regex, specified using the syntax $!1, $!2, etc. for groups 1, 2, etc.
modeYesEither "literal" or "regex", specifying how the `needle` parameter is to be interpreted.
allow_multiple_occurrencesNoIf True, the regex may match multiple occurrences in the file and all of them will be replaced. If this is set to False and the regex matches multiple occurrences, an error will be returned (and you may retry with a revised, more specific regex).

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate destructiveHint=true and readOnlyHint=false, which the description aligns with by describing a replacement operation. The description adds valuable behavioral context beyond annotations: it explains error handling when allow_multiple_occurrences is false, provides regex performance optimization tips, and mentions retry capabilities. However, it doesn't cover rate limits or specific permission requirements.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately front-loaded with the core purpose, but contains some redundancy in advocating for regex mode (mentioned multiple times with similar points). The 'VERY IMPORTANT' section could be more streamlined, though all sentences contribute meaningful guidance about tool usage strategies.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (destructive file operation with regex capabilities), the description provides comprehensive context: it explains when to use this versus alternatives, offers detailed regex usage strategies, describes error behavior, and references sibling tools. With annotations covering safety aspects and an output schema presumably handling return values, the description fills all necessary contextual gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the baseline is 3. The description adds meaningful context about parameter usage: it emphasizes regex mode advantages for large sections, explains wildcard strategies to avoid exact content specification, and clarifies the interaction between regex patterns and the allow_multiple_occurrences parameter. This provides practical guidance beyond the schema's technical specifications.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('replaces one or more occurrences of a given pattern in a file with new content') and distinguishes it from sibling tools by mentioning 'symbol-level tools' as alternatives. It explicitly names the resource (file content) and operation (replacement).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool ('preferred way to replace content... whenever the symbol-level tools are not appropriate') and offers detailed advice on regex mode usage versus literal mode. It also references sibling tools like 'replace_symbol_body' as alternatives for symbol-level operations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

replace_symbol_bodyReplace Symbol BodyA
Destructive

Replaces the body of the symbol with the given name_path.

The tool shall be used to replace symbol bodies that have been previously retrieved (e.g. via find_symbol). IMPORTANT: Do not use this tool if you do not know what exactly constitutes the body of the symbol.

ParametersJSON Schema
NameRequiredDescriptionDefault
name_pathYesFor finding the symbol to replace, same logic as in the `find_symbol` tool.
relative_pathYesThe relative path to the file containing the symbol.
bodyYesThe new symbol body. The symbol body is the definition of a symbol in the programming language, including e.g. the signature line for functions. IMPORTANT: The body does NOT include any preceding docstrings/comments or imports, in particular.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate destructiveHint=true and readOnlyHint=false, which the description aligns with by implying a mutation ('Replaces'). The description adds valuable context beyond annotations: it clarifies that the body excludes 'preceding docstrings/comments or imports,' specifies a prerequisite (previous retrieval via find_symbol), and warns about misuse if the body is unclear. This enhances behavioral understanding without contradicting annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose in the first sentence, followed by usage guidelines and a critical warning. Each sentence earns its place by providing essential information without redundancy, resulting in a well-structured and efficient text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (destructive mutation with 3 required parameters), the description is complete: it covers purpose, usage context, prerequisites, and critical warnings. With annotations providing safety cues and an output schema present (implying return values are documented elsewhere), no additional information is needed for effective tool selection and invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, providing detailed parameter documentation (e.g., 'body' includes the definition excluding docstrings). The description adds minimal semantics beyond the schema, such as linking 'name_path' to 'find_symbol' logic, but does not significantly enhance parameter understanding. With high schema coverage, a baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Replaces the body of the symbol') and identifies the target resource ('symbol with the given name_path'). It distinguishes from siblings like 'rename_symbol' (which changes the name) and 'replace_content' (which replaces file content rather than symbol bodies), establishing a unique purpose.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use ('to replace symbol bodies that have been previously retrieved via find_symbol') and when not to use ('Do not use this tool if you do not know what exactly constitutes the body of the symbol'). It also references a specific alternative tool ('find_symbol') for preparation, offering clear context for usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

search_for_patternSearch For PatternA
Read-only

Offers a flexible search for arbitrary patterns in the codebase, including the possibility to search in non-code files. Generally, symbolic operations like find_symbol or find_referencing_symbols should be preferred if you know which symbols you are looking for.

Pattern Matching Logic: For each match, the returned result will contain the full lines where the substring pattern is found, as well as optionally some lines before and after it. The pattern will be compiled with DOTALL, meaning that the dot will match all characters including newlines. This also means that it never makes sense to have .* at the beginning or end of the pattern, but it may make sense to have it in the middle for complex patterns. If a pattern matches multiple lines, all those lines will be part of the match. Be careful to not use greedy quantifiers unnecessarily, it is usually better to use non-greedy quantifiers like .*? to avoid matching too much content.

File Selection Logic: The files in which the search is performed can be restricted very flexibly. Using restrict_search_to_code_files is useful if you are only interested in code symbols (i.e., those symbols that can be manipulated with symbolic tools like find_symbol). You can also restrict the search to a specific file or directory, and provide glob patterns to include or exclude certain files on top of that. The globs are matched against relative file paths from the project root (not to the relative_path parameter that is used to further restrict the search). Smartly combining the various restrictions allows you to perform very targeted searches. Returns A mapping of file paths to lists of matched consecutive lines.

ParametersJSON Schema
NameRequiredDescriptionDefault
substring_patternYesRegular expression for a substring pattern to search for.
context_lines_beforeNoNumber of lines of context to include before each match.
context_lines_afterNoNumber of lines of context to include after each match.
paths_include_globNoOptional glob pattern specifying files to include in the search. Matches against relative file paths from the project root (e.g., "*.py", "src/**/*.ts"). Supports standard glob patterns (*, ?, [seq], **, etc.) and brace expansion {a,b,c}. Only matches files, not directories. If left empty, all non-ignored files will be included.
paths_exclude_globNoOptional glob pattern specifying files to exclude from the search. Matches against relative file paths from the project root (e.g., "*test*", "**/*_generated.py"). Supports standard glob patterns (*, ?, [seq], **, etc.) and brace expansion {a,b,c}. Takes precedence over paths_include_glob. Only matches files, not directories. If left empty, no files are excluded.
relative_pathNoOnly subpaths of this path (relative to the repo root) will be analyzed. If a path to a single file is passed, only that will be searched. The path must exist, otherwise a `FileNotFoundError` is raised.
restrict_search_to_code_filesNoWhether to restrict the search to only those files where analyzed code symbols can be found. Otherwise, will search all non-ignored files. Set this to True if your search is only meant to discover code that can be manipulated with symbolic tools. For example, for finding classes or methods from a name pattern. Setting to False is a better choice if you also want to search in non-code files, like in html or yaml files, which is why it is the default.
max_answer_charsNoIf the output is longer than this number of characters, no content will be returned. -1 means the default value from the config will be used. Don't adjust unless there is really no other way to get the content required for the task. Instead, if the output is too long, you should make a stricter query.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate readOnlyHint=true and destructiveHint=false, which the description aligns with by describing a search operation. The description adds significant behavioral context beyond annotations, detailing pattern matching logic (e.g., DOTALL compilation, line inclusion, greedy vs. non-greedy quantifiers) and file selection logic (e.g., glob patterns, restrictions), though it doesn't explicitly mention rate limits or auth needs, which are not contradictory.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections ('Pattern Matching Logic', 'File Selection Logic') and front-loaded key information. It is appropriately sized, but some sentences could be more concise (e.g., the explanation of DOTALL and greedy quantifiers is slightly verbose), though overall it avoids waste and is easy to follow.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of the tool (8 parameters, regex patterns, file restrictions) and the presence of annotations and an output schema (implied by 'Returns A mapping of file paths to lists of matched consecutive lines'), the description is complete. It covers usage scenarios, behavioral details, and parameter interactions without needing to explain return values, making it sufficient for an AI agent to use the tool effectively.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds some value by explaining the purpose of parameters like 'restrict_search_to_code_files' and how glob patterns work relative to the project root, but it doesn't provide significant additional semantics beyond what's in the schema, warranting a baseline score of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Offers a flexible search for arbitrary patterns in the codebase, including the possibility to search in non-code files.' It specifies the verb ('search'), resource ('patterns in the codebase'), and scope ('including non-code files'), and distinguishes it from sibling tools by explicitly mentioning alternatives like 'find_symbol' and 'find_referencing_symbols'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool versus alternatives: 'Generally, symbolic operations like find_symbol or find_referencing_symbols should be preferred if you know which symbols you are looking for.' It also advises on context, such as using 'restrict_search_to_code_files' for code symbols and setting it to 'False' for non-code files, offering clear alternatives and exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

switch_modesSwitch ModesB
Read-only

Activates the desired modes, like ["editing", "interactive"] or ["planning", "one-shot"].

ParametersJSON Schema
NameRequiredDescriptionDefault
modesYesThe names of the modes to activate.

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

B3.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate readOnlyHint=true and destructiveHint=false, so the agent knows this is a safe, non-destructive operation. The description adds minimal context by implying activation of modes, but doesn't disclose behavioral traits like what 'activation' entails (e.g., state changes, side effects, or interactions with other tools). It doesn't contradict annotations, but offers little beyond them.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads the purpose with examples. It avoids unnecessary words and gets straight to the point. However, it could be slightly more structured by explicitly stating the tool's role in the context of sibling tools, but as-is, it's concise and well-formed.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has an output schema (which handles return values), annotations covering safety, and high schema coverage, the description is minimally adequate. It explains the basic action but lacks context on what modes are, how they interact with other tools, or when to use this. For a tool that likely changes system state (despite readOnlyHint), more detail on behavior and usage would improve completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with the parameter 'modes' fully documented in the schema. The description adds value by providing examples (e.g., ['editing', 'interactive']), which clarify the expected format and possible values beyond the schema's generic array of strings. However, it doesn't explain semantics like what modes are available or their effects, keeping it at the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb ('Activates') and resource ('the desired modes'), making the purpose understandable. It provides specific examples like 'editing', 'interactive', 'planning', and 'one-shot' which help illustrate what modes might be. However, it doesn't explicitly differentiate from sibling tools like 'activate_project' or 'get_current_config', which could cause confusion about when to use this versus those alternatives.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, context for activation, or exclusions. Given sibling tools like 'activate_project' and 'get_current_config', the lack of differentiation leaves the agent without clear usage rules, relying solely on the tool name and description which are vague about scope.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

think_about_collected_informationThink About Collected InformationA
Read-only

Think about the collected information and whether it is sufficient and relevant. This tool should ALWAYS be called after you have completed a non-trivial sequence of searching steps like find_symbol, find_referencing_symbols, search_files_for_pattern, read_file, etc.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.9/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate readOnlyHint=true and destructiveHint=false, so the agent knows this is a safe, non-destructive operation. The description adds context about when to call it (after searching steps), which is useful behavioral guidance beyond the annotations. However, it doesn't disclose details like what the tool actually does (e.g., returns analysis, triggers internal processing) or any rate limits, leaving some behavioral aspects unclear.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences that are front-loaded with the core purpose and followed by specific usage guidelines. Every sentence adds value without redundancy, making it highly concise and well-structured for quick understanding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 0 parameters, annotations cover safety (read-only, non-destructive), an output schema exists (so return values are documented elsewhere), and the description provides clear usage context, it's mostly complete. However, it could be more explicit about what the tool outputs or how it aids decision-making, slightly reducing completeness.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters, and schema description coverage is 100%, so there's no need for parameter details in the description. The description appropriately doesn't discuss parameters, which is efficient. A baseline of 4 is applied since no parameters exist, and the description doesn't introduce unnecessary complexity.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool is for 'thinking about collected information' and assessing sufficiency/relevance, which gives a general purpose. However, it's somewhat vague about what specific action the tool performs (e.g., does it analyze, summarize, or just prompt reflection?) and doesn't clearly differentiate from sibling tools like 'think_about_task_adherence' or 'think_about_whether_you_are_done' beyond the information focus.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidance: it states the tool 'should ALWAYS be called after you have completed a non-trivial sequence of searching steps' and lists examples like 'find_symbol, find_referencing_symbols, search_files_for_pattern, read_file, etc.' This clearly defines when to use it versus alternatives, making it highly actionable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

think_about_task_adherenceThink About Task AdherenceA
Read-only

Think about the task at hand and whether you are still on track. Especially important if the conversation has been going on for a while and there has been a lot of back and forth.

This tool should ALWAYS be called before you insert, replace, or delete code.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.6/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate readOnlyHint=true and destructiveHint=false, which already convey that this is a safe, non-destructive operation. The description adds context about its role in ensuring task adherence before code modifications, which is useful behavioral insight beyond the annotations. However, it does not detail aspects like potential side effects, performance implications, or error handling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and front-loaded, with three sentences that directly address purpose and usage without unnecessary details. Each sentence adds value, such as the specific trigger conditions and mandatory usage before code changes, making it well-structured and efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (low, with 0 parameters), rich annotations (readOnlyHint, destructiveHint), and the presence of an output schema, the description is complete enough. It explains the tool's role in task adherence and when to use it, which aligns with the structured data. However, it could slightly enhance completeness by mentioning what the output schema returns, though this is not strictly necessary.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool has 0 parameters, and schema description coverage is 100%, so there is no need for parameter explanation in the description. The description appropriately does not discuss parameters, which is efficient, but since there are no parameters, a baseline of 4 is applied as it fully compensates for the lack of parameter details.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool's purpose as 'Think about the task at hand and whether you are still on track,' which is a clear action but somewhat vague in scope. It does not specify what resources or data it operates on, and it does not distinguish itself from sibling tools like 'think_about_collected_information' or 'think_about_whether_you_are_done,' making it less specific than ideal.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit usage guidelines: 'Especially important if the conversation has been going on for a while and there has been a lot of back and forth' and 'This tool should ALWAYS be called before you insert, replace, or delete code.' This gives clear context for when to use it, though it does not explicitly state when not to use it or compare it to alternatives like other 'think' tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

think_about_whether_you_are_doneThink About Whether You Are DoneA
Read-only

Whenever you feel that you are done with what the user has asked for, it is important to call this tool.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate readOnlyHint=true and destructiveHint=false, which the description does not contradict. The description adds context by implying this is a self-assessment or decision-making tool, but it does not disclose additional behavioral traits like what triggers the 'done' state, any side effects, or how it interacts with other tools. With annotations covering safety, the description provides minimal extra value.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that directly states the tool's purpose and usage. It is front-loaded with the key information and contains no redundant or extraneous details, making it highly concise and well-structured for quick understanding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has 0 parameters, annotations covering read-only and non-destructive behavior, and an output schema exists, the description is reasonably complete. It explains when to use the tool, which is the core need. However, it could be more detailed about what 'done' entails or how it integrates with other tools, leaving minor gaps in full context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description does not add parameter details, which is appropriate. A baseline of 4 is applied since there are no parameters, and the description does not introduce unnecessary complexity.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool's purpose as 'call this tool whenever you feel that you are done with what the user has asked for,' which is a clear action but vague in scope. It specifies a verb ('call') but lacks concrete details about what 'done' means or what resource it operates on, making it somewhat ambiguous compared to more specific sibling tools like 'create_text_file' or 'read_file'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use the tool: 'whenever you feel that you are done with what the user has asked for.' This gives a clear context for invocation. However, it does not mention when not to use it or name alternatives, such as sibling tools like 'think_about_collected_information' or 'think_about_task_adherence,' which might be relevant for related decision-making processes.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

write_memoryWrite MemoryA
Destructive

Write some information (utf-8-encoded) about this project that can be useful for future tasks to a memory in md format. The memory name should be meaningful.

ParametersJSON Schema
NameRequiredDescriptionDefault
memory_file_nameYes
contentYes
max_answer_charsNo

Output Schema

ParametersJSON Schema
NameRequiredDescription
resultYes

TDQS

A3.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate destructiveHint=true and readOnlyHint=false, which the description aligns with by implying a write operation. The description adds valuable context beyond annotations: it specifies the memory is stored in markdown format and should have a meaningful name, which helps the agent understand behavioral expectations. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two concise sentences that front-load the core purpose and key requirements. Every word adds value: the first sentence covers action, content, format, and purpose; the second emphasizes naming quality. No wasted words or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given a destructive tool with 3 parameters (0% schema coverage) and an output schema, the description adequately covers the purpose and format but lacks parameter details and behavioral nuances like error handling or idempotency. The output schema may help with return values, but the description doesn't fully compensate for the low parameter coverage.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It mentions 'memory name should be meaningful' (hinting at memory_file_name) and 'information... to a memory' (hinting at content), but doesn't explain max_answer_chars or provide details on parameter formats, constraints, or interactions. This leaves significant gaps in parameter understanding.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Write some information') and resource ('to a memory'), specifying the format ('md format') and encoding ('utf-8-encoded'). It distinguishes from siblings like 'read_memory' and 'edit_memory' by focusing on creation, but doesn't explicitly differentiate from 'create_text_file' which might have overlapping functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context ('about this project', 'useful for future tasks'), suggesting when to use it for project documentation. However, it lacks explicit guidance on when to choose this over alternatives like 'create_text_file' or 'edit_memory', and doesn't mention prerequisites or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 17 tool updatesv1.0.0
    • Changedcreate_text_file1 field changed
      • changedInput schema / properties / content / description
        Previous value: -"The (utf-8-encoded) content to write to the file."New value: +"The (appropriately encoded) content to write to the file."
    • Addededit_memory
    • Changedexecute_shell_command2 fields changed
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
      • changedInput schema / properties / max_answer_chars / description
        Previous value: -"If the output is longer than this number of characters,\nno content will be returned. Don't adjust unless there is really no other way to get the content\nrequired for the task."New value: +"If the output is longer than this number of characters,\nno content will be returned. -1 means using the default value, don't adjust unless there is no other way to get the content\nrequired for the task."
    • Changedfind_referencing_symbols1 field changed
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
    • Changedfind_symbol7 fields changed
      • changedInput schema / properties / depth / description
        Previous value: -"Depth to retrieve descendants (e.g., 1 for class methods/attributes)."New value: +"Depth up to which descendants shall be retrieved (e.g. use 1 to also retrieve immediate children;\nfor the case where the symbol is a class, this will return its methods).\nDefault 0."
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
      • changedInput schema / properties / max_answer_chars / description
        Previous value: -"Max characters for the JSON result. If exceeded, no content is returned."New value: +"Max characters for the JSON result. If exceeded, no content is returned.\n-1 means the default value from the config will be used."
      • removedInput schema / properties / name_path
        Removed value: -{
        -  "description": "The name path pattern to search for, see above for details.",
        -  "title": "Name Path",
        -  "type": "string"
        -}
      • addedInput schema / properties / name_path_pattern
        Added value: +{
        +  "description": "The name path matching pattern (see above).",
        +  "title": "Name Path Pattern",
        +  "type": "string"
        +}
      • changedInput schema / properties / substring_matching / description
        Previous value: -"If True, use substring matching for the last segment of `name`."New value: +"If True, use substring matching for the last element of the pattern, such that\n\"Foo/get\" would match \"Foo/getValue\" and \"Foo/getData\"."
      • changedInput schema / required
        Previous value: -[
        -  "name_path"
        -]New value: +[
        +  "name_path_pattern"
        +]
    • Addedget_current_config
    • Changedget_symbols_overview3 fields changed
      • addedInput schema / properties / depth
        Added value: +{
        +  "default": 0,
        +  "description": "Depth up to which descendants of top-level symbols shall be retrieved\n(e.g. 1 retrieves immediate children). Default 0.",
        +  "title": "Depth",
        +  "type": "integer"
        +}
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
      • changedInput schema / properties / max_answer_chars / description
        Previous value: -"If the overview is longer than this number of characters,\nno content will be returned. Don't adjust unless there is really no other way to get the content\nrequired for the task."New value: +"If the overview is longer than this number of characters,\nno content will be returned. -1 means the default value from the config will be used.\nDon't adjust unless there is really no other way to get the content required for the task."
    • Addedinitial_instructions
    • Changedlist_dir3 fields changed
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
      • changedInput schema / properties / max_answer_chars / description
        Previous value: -"If the output is longer than this number of characters,\nno content will be returned. Don't adjust unless there is really no other way to get the content\nrequired for the task."New value: +"If the output is longer than this number of characters,\nno content will be returned. -1 means the default value from the config will be used.\nDon't adjust unless there is really no other way to get the content required for the task."
      • addedInput schema / properties / skip_ignored_files
        Added value: +{
        +  "default": false,
        +  "description": "Whether to skip files and directories that are ignored.",
        +  "title": "Skip Ignored Files",
        +  "type": "boolean"
        +}
    • Changedread_file1 field changed
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
    • Changedread_memory1 field changed
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
    • Addedrename_symbol
    • Addedreplace_content
    • Removedreplace_regex
    • Changedreplace_symbol_body1 field changed
      • changedInput schema / properties / body / description
        Previous value: -"The new symbol body. Important: Begin directly with the symbol definition and provide no\nleading indentation for the first line (but do indent the rest of the body according to the context)."New value: +"The new symbol body. The symbol body is the definition of a symbol\nin the programming language, including e.g. the signature line for functions.\nIMPORTANT: The body does NOT include any preceding docstrings/comments or imports, in particular."
    • Changedsearch_for_pattern4 fields changed
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
      • changedInput schema / properties / max_answer_chars / description
        Previous value: -"If the output is longer than this number of characters,\nno content will be returned. Don't adjust unless there is really no other way to get the content\nrequired for the task. Instead, if the output is too long, you should\nmake a stricter query."New value: +"If the output is longer than this number of characters,\nno content will be returned.\n-1 means the default value from the config will be used.\nDon't adjust unless there is really no other way to get the content\nrequired for the task. Instead, if the output is too long, you should\nmake a stricter query."
      • changedInput schema / properties / paths_exclude_glob / description
        Previous value: -"Optional glob pattern specifying files to exclude from the search.\nMatches against relative file paths from the project root (e.g., \"*test*\", \"**/*_generated.py\").\nTakes precedence over paths_include_glob. Only matches files, not directories. If left empty, no files are excluded."New value: +"Optional glob pattern specifying files to exclude from the search.\nMatches against relative file paths from the project root (e.g., \"*test*\", \"**/*_generated.py\").\nSupports standard glob patterns (*, ?, [seq], **, etc.) and brace expansion {a,b,c}.\nTakes precedence over paths_include_glob. Only matches files, not directories. If left empty, no files are excluded."
      • changedInput schema / properties / paths_include_glob / description
        Previous value: -"Optional glob pattern specifying files to include in the search.\nMatches against relative file paths from the project root (e.g., \"*.py\", \"src/**/*.ts\").\nOnly matches files, not directories. If left empty, all non-ignored files will be included."New value: +"Optional glob pattern specifying files to include in the search.\nMatches against relative file paths from the project root (e.g., \"*.py\", \"src/**/*.ts\").\nSupports standard glob patterns (*, ?, [seq], **, etc.) and brace expansion {a,b,c}.\nOnly matches files, not directories. If left empty, all non-ignored files will be included."
    • Changedwrite_memory4 fields changed
      • changedInput schema / properties / max_answer_chars / default
        Previous value: -200000New value: +-1
      • addedInput schema / properties / memory_file_name
        Added value: +{
        +  "title": "Memory File Name",
        +  "type": "string"
        +}
      • removedInput schema / properties / memory_name
        Removed value: -{
        -  "title": "Memory Name",
        -  "type": "string"
        -}
      • changedInput schema / required
        Previous value: -[
        -  "memory_name",
        -  "content"
        -]New value: +[
        +  "memory_file_name",
        +  "content"
        +]
  2. 25 tool updates
    • First observedactivate_project
    • First observedcheck_onboarding_performed
    • First observedcreate_text_file
    • First observeddelete_memory
    • First observedexecute_shell_command
    • First observedfind_file
    • First observedfind_referencing_symbols
    • First observedfind_symbol
    • First observedget_symbols_overview
    • First observedinsert_after_symbol
    • First observedinsert_before_symbol
    • First observedlist_dir
    • First observedlist_memories
    • First observedonboarding
    • First observedprepare_for_new_conversation
    • First observedread_file
    • First observedread_memory
    • First observedreplace_regex
    • First observedreplace_symbol_body
    • First observedsearch_for_pattern
    • First observedswitch_modes
    • First observedthink_about_collected_information
    • First observedthink_about_task_adherence
    • First observedthink_about_whether_you_are_done
    • First observedwrite_memory

TDQS

A3.8/5.0
Disambiguation4/5

Most tools have distinct purposes, but there is some overlap between search tools (find_symbol, find_referencing_symbols, search_for_pattern) and file operations (read_file vs. find_file vs. list_dir). The descriptions help clarify differences, but an agent might occasionally misselect between similar search or file access tools.

Naming Consistency4/5

The naming follows a consistent verb_noun pattern (e.g., activate_project, create_text_file, execute_shell_command) with only minor deviations like initial_instructions (adjective_noun) and think_about_* tools (verb_phrase). Overall, the pattern is predictable and readable.

Tool Count3/5

With 29 tools, the count feels heavy for a code assistant server, bordering on overwhelming. While many tools are specialized (e.g., multiple think_about_* tools), the high number could lead to confusion or inefficiency in tool selection.

Completeness5/5

The toolset provides comprehensive coverage for code editing and project management, including CRUD operations for files and symbols, search capabilities, memory management, and workflow guidance (e.g., onboarding, thinking tools). No obvious gaps are present for its intended domain.

Maintenance

ActivityActive
ResponsivenessResponsive

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

  • A
    license
    B
    quality
    C
    maintenance
    A coding agent toolkit that transforms LLMs into coding assistants capable of working directly on your codebase with semantic code retrieval and editing tools, providing IDE-like capabilities without requiring API subscriptions.
    33
    1
    MIT
  • A
    license
    Not graded
    quality
    B
    maintenance
    Provides semantic code intelligence tools (search, structural views) and a workspace TUI interface for LLM agents to efficiently navigate codebases, manage context, and maintain architectural patterns across Python, Java, C++, and Perl projects.
    4
    MIT
  • A
    license
    B
    quality
    D
    maintenance
    A coding agent toolkit that provides IDE-like semantic code retrieval and editing tools, enabling LLMs to efficiently navigate and modify codebases using symbol-level operations instead of basic file reading and string replacements.
    19
    MIT
  • F
    license
    Not graded
    quality
    D
    maintenance
    Provides Cursor-like code intelligence using tools like ripgrep, ctags, and tree-sitter to help LLMs explore and understand entire codebases. It implements a structured, phase-gated workflow to ensure high-confidence code modifications and eliminate hallucinations.
    -

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/oraios/serena'

If you have feedback or need assistance with the MCP directory API, please join our Discord server