Skip to main content
Glama

listResults

listResults

Retrieve and manage chatbot interaction results from MCP-Typebot by specifying bot ID, time filters, and result limits to organize and analyze user engagement data effectively.

Instructions

Lista resultados de un Typebot

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
botIdYes
cursorNo
limitNo
timeFilterNo
timeZoneNo

Implementation Reference

  • The main handler function that implements the listResults tool logic, authenticating and calling the Typebot API to list results.
    export async function listResults(args: ListResultsArgs) {
      ensureAuth(); 
      const {
        botId,
        limit = 50,
        cursor,
        timeFilter = 'last7Days',
        timeZone,
      } = args;
    
      if (!botId) throw new Error('listResults: falta botId');
      if (limit < 1 || limit > 100) {
        throw new Error('listResults: limit debe estar entre 1 y 100');
      }
    
      const params: Record<string, any> = { limit, timeFilter };
      if (cursor) params.cursor = cursor;
      if (timeZone) params.timeZone = timeZone;
    
      const response = await axios.get(
        `https://app.typebot.io/api/v1/typebots/${botId}/results`,
        { params }
      );
      return response.data;
    }
  • TypeScript interface defining the input parameters for the listResults function.
    export interface ListResultsArgs {
      botId: string;
      limit?: number;
      cursor?: string;
      timeFilter?:
        | 'today'
        | 'last7Days'
        | 'last30Days'
        | 'monthToDate'
        | 'lastMonth'
        | 'yearToDate'
        | 'allTime';
      timeZone?: string;
    }
  • Zod schema used for input validation of the listResults tool.
    schema: z.object({
      botId:      z.string().min(1, "El campo 'botId' es obligatorio."),
      limit:      z.number().int().min(1).max(100).optional(),
      cursor:     z.string().optional(),
      timeFilter: z.string().optional(),
      timeZone:   z.string().optional(),
    }),
  • src/index.ts:79-89 (registration)
    Registration configuration for the listResults tool in the tools map, which is later used to register with the MCP server.
    ['listResults', {
      func: listResults,
      description: 'Lista resultados de un Typebot',
      schema: z.object({
        botId:      z.string().min(1, "El campo 'botId' es obligatorio."),
        limit:      z.number().int().min(1).max(100).optional(),
        cursor:     z.string().optional(),
        timeFilter: z.string().optional(),
        timeZone:   z.string().optional(),
      }),
    }],
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. It only states the action ('Lista') without detailing behavioral traits such as whether this is a read-only operation, pagination behavior (implied by 'cursor' and 'limit' parameters but not explained), rate limits, authentication needs, or what the output looks like. For a tool with 5 parameters and no annotations, this is a significant gap in transparency.

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 in Spanish ('Lista resultados de un Typebot'), which is appropriately concise and front-loaded with the core action. There's no wasted verbiage, though it could benefit from slightly more detail given the tool's complexity.

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 complexity (5 parameters, 1 required), lack of annotations, and no output schema, the description is incomplete. It doesn't provide enough context for the agent to understand how to use the tool effectively, what the parameters mean, or what to expect in return. The description should do more to compensate for these gaps in structured data.

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?

The schema description coverage is 0%, meaning none of the 5 parameters (botId, cursor, limit, timeFilter, timeZone) are documented in the schema. The description adds no information about these parameters, failing to compensate for the lack of schema documentation. It doesn't explain what 'botId' refers to, how 'cursor' works for pagination, the purpose of 'timeFilter' and 'timeZone', or the context for 'limit'.

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 'Lista resultados de un Typebot' clearly states the verb ('Lista') and resource ('resultados de un Typebot'), making the basic purpose understandable. However, it's somewhat vague about what 'resultados' specifically means (e.g., chat session outcomes, analytics data) and doesn't distinguish this tool from potential sibling tools that might also list data, like 'listBots' which lists bots rather than results.

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 botId), exclusions, or compare it to sibling tools like 'getBot' or 'startChat'. This leaves the agent with minimal context for tool selection.

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