Skip to main content
Glama
nks-hub

rybbit-mcp

by nks-hub

List Funnels

rybbit_list_funnels
Read-onlyIdempotent

Retrieve all saved conversion funnels and their step definitions for a specific website using Rybbit Analytics data.

Instructions

List all saved funnels for a site with their step definitions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteIdYesSite ID (numeric ID or domain identifier)

Implementation Reference

  • The async handler function for the 'rybbit_list_funnels' tool, which performs a GET request to fetch funnel definitions for a specific site.
    async (args) => {
      try {
        const { siteId } = args as { siteId: string };
    
        const data = await client.get<FunnelDefinition[]>(
          `/sites/${siteId}/funnels`
        );
        return {
          content: [{ type: "text" as const, text: truncateResponse(data) }],
        };
      } catch (err) {
        const message = err instanceof Error ? err.message : String(err);
        return {
          content: [{ type: "text" as const, text: `Error: ${message}` }],
          isError: true,
        };
      }
    }
  • The registration of the 'rybbit_list_funnels' tool, including its metadata, description, and input schema.
    server.registerTool(
      "rybbit_list_funnels",
      {
        title: "List Funnels",
        description:
          "List all saved funnels for a site with their step definitions.",
        annotations: {
          readOnlyHint: true,
          idempotentHint: true,
          openWorldHint: true,
          destructiveHint: false,
        },
        inputSchema: {
          siteId: siteIdSchema,
        },
      },
Behavior3/5

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

Annotations already establish read-only, idempotent, non-destructive traits. The description adds valuable context that returned funnels include 'step definitions,' hinting at the data structure, but omits details about pagination, caching, or potential rate limiting.

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?

Single sentence, front-loaded with the action verb, zero redundancy. Every word earns its place: 'saved' distinguishes from ad-hoc funnels, 'step definitions' clarifies return payload. Appropriately sized for a simple list operation.

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?

For a single-parameter read operation with complete schema coverage and strong annotations, the description is adequate. It hints at return structure via 'step definitions' despite lacking an output schema, though explicitly stating return format would strengthen it further.

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 coverage, the baseline is 3. The description implies the site context ('for a site') matching the siteId parameter but adds no additional semantic details, examples, or format guidance beyond the schema's 'numeric ID or domain identifier' description.

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?

Description provides specific verb ('List'), resource ('saved funnels'), scope ('for a site'), and distinguishes from siblings like 'rybbit_analyze_funnel' and 'rybbit_get_funnel_step_sessions' by specifying it returns 'step definitions' (configuration/metadata) rather than analytics or session data.

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 this tool retrieves funnel definitions/configuration rather than performance data through the phrase 'step definitions,' but provides no explicit when-to-use guidance or named alternatives (e.g., contrasting with analyze_funnel for metrics).

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/nks-hub/rybbit-mcp'

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