Skip to main content
Glama
nks-hub

rybbit-mcp

by nks-hub

Update Site Config

rybbit_update_site_config
Idempotent

Modify tracking settings for a Rybbit Analytics site to control data collection, including IP tracking, session replay, error monitoring, and user interaction events.

Instructions

Update configuration for an existing Rybbit site. Toggle tracking features like IP tracking, session replay, error tracking, button clicks, etc.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteIdYesSite ID (numeric ID or domain identifier)
publicNoMake site stats publicly accessible
saltUserIdsNoSalt user IDs for privacy
blockBotsNoBlock known bots from tracking
trackIpNoTrack visitor IP addresses
trackErrorsNoTrack JavaScript errors
trackOutboundNoTrack outbound link clicks
trackUrlParamsNoTrack URL parameters
trackInitialPageViewNoTrack initial page view automatically
trackSpaNavigationNoTrack SPA navigation events
trackButtonClicksNoTrack button click events
trackCopyNoTrack text copy events
trackFormInteractionsNoTrack form interaction events
sessionReplayNoEnable session replay recording
webVitalsNoTrack Core Web Vitals metrics

Implementation Reference

  • Handler function for rybbit_update_site_config that updates site configuration via a PUT request.
    async ({ siteId, ...config }) => {
      try {
        // Filter out undefined values
        const body: Record<string, unknown> = {};
        for (const [key, value] of Object.entries(config)) {
          if (value !== undefined) {
            body[key] = value;
          }
        }
    
        if (Object.keys(body).length === 0) {
          return {
            content: [
              {
                type: "text" as const,
                text: "No configuration changes provided. Specify at least one setting to update.",
              },
            ],
          };
        }
    
        const data = await client.put<{ success: boolean; config: Record<string, unknown> }>(
          `/sites/${siteId}/config`,
          body
        );
    
        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,
        };
      }
    }
  • Input schema definition for rybbit_update_site_config.
    inputSchema: {
      siteId: siteIdSchema,
      public: z.boolean().optional().describe("Make site stats publicly accessible"),
      saltUserIds: z.boolean().optional().describe("Salt user IDs for privacy"),
      blockBots: z.boolean().optional().describe("Block known bots from tracking"),
      trackIp: z.boolean().optional().describe("Track visitor IP addresses"),
      trackErrors: z.boolean().optional().describe("Track JavaScript errors"),
      trackOutbound: z.boolean().optional().describe("Track outbound link clicks"),
      trackUrlParams: z.boolean().optional().describe("Track URL parameters"),
      trackInitialPageView: z.boolean().optional().describe("Track initial page view automatically"),
      trackSpaNavigation: z.boolean().optional().describe("Track SPA navigation events"),
      trackButtonClicks: z.boolean().optional().describe("Track button click events"),
      trackCopy: z.boolean().optional().describe("Track text copy events"),
      trackFormInteractions: z.boolean().optional().describe("Track form interaction events"),
      sessionReplay: z.boolean().optional().describe("Enable session replay recording"),
      webVitals: z.boolean().optional().describe("Track Core Web Vitals metrics"),
    },
  • Tool registration for rybbit_update_site_config.
    server.registerTool(
      "rybbit_update_site_config",
      {
        title: "Update Site Config",
        description:
          "Update configuration for an existing Rybbit site. Toggle tracking features like IP tracking, session replay, error tracking, button clicks, etc.",
        inputSchema: {
          siteId: siteIdSchema,
          public: z.boolean().optional().describe("Make site stats publicly accessible"),
          saltUserIds: z.boolean().optional().describe("Salt user IDs for privacy"),
          blockBots: z.boolean().optional().describe("Block known bots from tracking"),
          trackIp: z.boolean().optional().describe("Track visitor IP addresses"),
          trackErrors: z.boolean().optional().describe("Track JavaScript errors"),
          trackOutbound: z.boolean().optional().describe("Track outbound link clicks"),
          trackUrlParams: z.boolean().optional().describe("Track URL parameters"),
          trackInitialPageView: z.boolean().optional().describe("Track initial page view automatically"),
          trackSpaNavigation: z.boolean().optional().describe("Track SPA navigation events"),
          trackButtonClicks: z.boolean().optional().describe("Track button click events"),
          trackCopy: z.boolean().optional().describe("Track text copy events"),
          trackFormInteractions: z.boolean().optional().describe("Track form interaction events"),
          sessionReplay: z.boolean().optional().describe("Enable session replay recording"),
          webVitals: z.boolean().optional().describe("Track Core Web Vitals metrics"),
        },
        annotations: {
          readOnlyHint: false,
          destructiveHint: false,
          idempotentHint: true,
          openWorldHint: true,
        },
      },
Behavior3/5

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

Annotations already declare idempotentHint=true, destructiveHint=false, and readOnlyHint=false. The description adds value by describing the operation as 'Toggle tracking features,' which implies boolean state changes and reinforces the idempotent nature. However, it doesn't disclose additional behavioral traits like whether changes are immediate, if there are rate limits, or what happens if invalid feature combinations are selected.

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?

Two sentences with zero waste. The first establishes the core operation and target resource; the second provides concrete examples of configurable features. Every word earns its place—'Toggle' implies boolean parameters, while the examples clarify the domain-specific meaning of 'configuration.'

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 15 parameters with 100% schema coverage and clear annotations, the description provides sufficient context for an update operation. It appropriately doesn't describe return values since no output schema exists. Minor gap: could explicitly mention that partial updates are supported (only siteId is required), though this is inferable from the schema.

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 15 parameters. The description provides baseline value by categorizing the parameters as 'tracking features' and giving concrete examples (IP tracking, session replay, button clicks) that map to specific schema fields, helping the agent understand the semantic grouping of the boolean toggles.

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 clearly states the specific action (Update) and resource (configuration for an existing Rybbit site). It distinguishes from sibling rybbit_create_site by specifying 'existing' site, and from rybbit_get_config by using the verb 'Update' vs 'Get'. The scope is further clarified by listing specific tracking features that can be modified.

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 by specifying 'existing Rybbit site' and listing tracking toggle examples, suggesting when to use it (when modifying tracking settings). However, it lacks explicit guidance on when to use this versus rybbit_get_config (read alternative) or prerequisites like needing the siteId first.

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