Skip to main content
Glama

getBot

getBot

Retrieve a Typebot chatbot by its unique ID using the MCP-Typebot server for efficient bot management and integration.

Instructions

Recupera un Typebot por su ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
botIdYes

Implementation Reference

  • The main execution function (handler) for the 'getBot' tool. It ensures authentication, validates botId, and fetches the bot data from the Typebot API using axios.
    export async function getBot(args: GetBotArgs) {
      ensureAuth(); 
      const { botId } = args;
      if (!botId) throw new Error('getBot: falta botId');
    
      const response = await axios.get(
        `https://app.typebot.io/api/v1/typebots/${botId}`
      );
      return response.data;
    }
  • TypeScript interface defining the expected input shape for the getBot handler: an object with a required 'botId' string.
    export interface GetBotArgs {
      botId: string;
    }
  • src/index.ts:50-54 (registration)
    The tool registration entry in the toolsMap Map, which includes the handler reference (getBot), description, and Zod input validation schema. This is later used in server.registerTool().
    ['getBot', {
      func: getBot,
      description: 'Recupera un Typebot por su ID',
      schema: z.object({ botId: z.string().min(1, "El campo 'botId' es obligatorio.") }),
    }],
  • Zod schema for input validation of the 'getBot' tool, requiring a non-empty 'botId' string.
    schema: z.object({ botId: z.string().min(1, "El campo 'botId' es obligatorio.") }),
Behavior2/5

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

With no annotations provided, the description carries full burden but offers minimal behavioral context. It states it retrieves by ID but doesn't disclose error handling (e.g., if botId is invalid), authentication needs, rate limits, or what the return format looks like. 'Recupera' implies a read operation, but no further details are given.

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 with zero waste. It's front-loaded with the core action and resource, making it easy to parse quickly. No extraneous information or redundancy is present.

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

Completeness2/5

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

Given the tool's simplicity (1 parameter, no annotations, no output schema), the description is incomplete. It lacks details on error cases, return values, or integration with siblings (e.g., how botId relates to listBots). For a retrieval tool, more context on what 'recupera' entails would be helpful.

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 description mentions 'por su ID' (by its ID), which aligns with the single parameter botId in the schema. However, schema description coverage is 0%, so the schema provides no param details. The description adds basic semantics (ID-based retrieval) but doesn't explain botId format, constraints, or examples, leaving gaps.

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 ('Recupera' meaning 'Retrieves') and resource ('un Typebot'), specifying it's a retrieval operation by ID. It distinguishes from siblings like listBots (which lists multiple) and createBot/updateBot (which modify). However, it doesn't explicitly mention what a 'Typebot' is, which slightly reduces specificity.

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 (e.g., needing a valid botId), when to choose getBot over listBots for single retrieval, or any exclusions. The agent must infer usage from the name and context alone.

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

Related 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/osdeibi/MCP-typebot'

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