Skip to main content
Glama

Get Tool Help

get-tool-help

Retrieve detailed usage information and parameters for specific MCP Firebird database tools to understand their functionality and proper implementation.

Instructions

Obtiene información detallada sobre una herramienta específica

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toolNameYesNombre de la herramienta sobre la que obtener ayuda

Implementation Reference

  • The async handler function that implements the logic for the 'get-tool-help' tool. It retrieves detailed information about the specified tool from available database and metadata tools, formats it nicely, and returns it in the expected MCP response format.
    handler: async (args: { toolName: string }) => {
        try {
            const allTools = new Map([...databaseTools, ...tools]);
            const tool = allTools.get(args.toolName);
    
            if (!tool) {
                return {
                    content: [{
                        type: 'text',
                        text: `Herramienta '${args.toolName}' no encontrada. Use 'list-available-tools' para ver las herramientas disponibles.`
                    }],
                    isError: true
                };
            }
    
            const helpInfo = {
                name: args.toolName,
                title: tool.title || args.toolName,
                description: tool.description,
                category: databaseTools.has(args.toolName) ? 'database' : 'metadata',
                inputSchema: tool.inputSchema ? 'Disponible' : 'No definido',
                usage: `Para usar esta herramienta, llame a '${args.toolName}' con los parámetros apropiados.`
            };
    
            return {
                content: [{
                    type: 'text',
                    text: `Ayuda para la herramienta: ${args.toolName}\n\n${formatForClaude(helpInfo)}`
                }]
            };
        } catch (error) {
            logger.error('Error getting tool help:', { error });
            return {
                content: [{
                    type: 'text',
                    text: `Error obteniendo ayuda: ${error instanceof Error ? error.message : String(error)}`
                }],
                isError: true
            };
        }
    }
  • The Zod input schema for the 'get-tool-help' tool, requiring a 'toolName' string parameter.
    inputSchema: z.object({
        toolName: z.string().describe('Nombre de la herramienta sobre la que obtener ayuda')
    }),
  • The registration of the 'get-tool-help' tool within the setupMetadataTools function, adding it to the metadata tools Map.
    tools.set('get-tool-help', {
        title: 'Get Tool Help',
        description: 'Obtiene información detallada sobre una herramienta específica',
        inputSchema: z.object({
            toolName: z.string().describe('Nombre de la herramienta sobre la que obtener ayuda')
        }),
        handler: async (args: { toolName: string }) => {
            try {
                const allTools = new Map([...databaseTools, ...tools]);
                const tool = allTools.get(args.toolName);
    
                if (!tool) {
                    return {
                        content: [{
                            type: 'text',
                            text: `Herramienta '${args.toolName}' no encontrada. Use 'list-available-tools' para ver las herramientas disponibles.`
                        }],
                        isError: true
                    };
                }
    
                const helpInfo = {
                    name: args.toolName,
                    title: tool.title || args.toolName,
                    description: tool.description,
                    category: databaseTools.has(args.toolName) ? 'database' : 'metadata',
                    inputSchema: tool.inputSchema ? 'Disponible' : 'No definido',
                    usage: `Para usar esta herramienta, llame a '${args.toolName}' con los parámetros apropiados.`
                };
    
                return {
                    content: [{
                        type: 'text',
                        text: `Ayuda para la herramienta: ${args.toolName}\n\n${formatForClaude(helpInfo)}`
                    }]
                };
            } catch (error) {
                logger.error('Error getting tool help:', { error });
                return {
                    content: [{
                        type: 'text',
                        text: `Error obteniendo ayuda: ${error instanceof Error ? error.message : String(error)}`
                    }],
                    isError: true
                };
            }
        }
    });
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. While 'obtiene información' implies a read-only operation, it doesn't specify whether this requires authentication, what happens if the tool name is invalid, whether there are rate limits, or what the return format looks like. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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 in Spanish that directly states the tool's purpose without unnecessary words. It's appropriately sized for a simple lookup tool and front-loads the core functionality. Every word earns its place.

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's simple nature (single parameter lookup), no output schema, and no annotations, the description is minimally adequate but has clear gaps. It explains what the tool does but doesn't provide enough context about behavioral aspects, return format, or usage scenarios. For a help tool in a system with many siblings, more guidance would be beneficial.

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, with the single parameter 'toolName' clearly documented as 'Nombre de la herramienta sobre la que obtener ayuda'. The description adds no additional parameter semantics beyond what the schema already provides. With high schema coverage, the baseline score of 3 is appropriate as the schema does the heavy lifting.

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 'obtiene' (gets) and the resource 'información detallada sobre una herramienta específica' (detailed information about a specific tool). It distinguishes itself from siblings like 'list-available-tools' by focusing on detailed help for a single tool rather than listing available tools. However, it doesn't explicitly mention what format the help information comes in or how it differs from other metadata tools.

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 like needing to know the tool name first, nor does it differentiate from siblings like 'list-available-tools' (which lists tools) or 'get-database-info' (which might provide system-level help). There's no explicit when/when-not or alternative tool recommendations.

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

Install Server

Other Tools

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/PuroDelphi/mcpFirebird'

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