Skip to main content
Glama
Sign In

Scribe Mail

by com.scribe-mail
OverviewDiscussionsAdmin

Analytics — signature clicks

get_analytics_clicks
Read-onlyIdempotent

Signature-click counts over a date range. By DEFAULT a timeseries bucketed by granularity (hour/day/week/month, UTC): { data:[{period, count}], totals:{count} }. Set group_by (signature_template | marketing_campaign | teammate | country) for a ranked breakdown instead: { data:[{id, label, view_count, click_count, clickthrough_rate}], pagination } — each breakdown row already carries views, clicks, AND the clickthrough rate, so one call answers "which signature/teammate drives the most engagement". Filter by start_date/end_date and any of signature_template_id, marketing_campaign_id, teammate_id.

Input Schema

NameRequiredDescriptionDefault
pageNo1-based page (breakdown only; ignored for the timeseries).
limitNoPage size 1–100 (breakdown only; default 20).
orderNoSort direction. Default desc.
contextYesExplain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as "a user", "the customer", or "an account". Example: "Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution."
end_dateNoRange end (inclusive), ISO-8601 date YYYY-MM-DD. Default: today.
group_byNoIf set, return a ranked breakdown by this dimension instead of a timeseries: signature_template | marketing_campaign | teammate | anchor (link) | country.
start_dateNoRange start (inclusive), ISO-8601 date YYYY-MM-DD. Default: 2 months ago.
granularityNoTimeseries bucket size: hour | day | week | month (default day). Ignored when `group_by` is set. `hour` is capped at a 31-day range.
teammate_idNoRestrict to one teammate (their UUID).
marketing_campaign_idNoRestrict to one marketing campaign (its UUID).
signature_template_idNoRestrict to one signature template (its UUID).

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / result / anyOf
      Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "data": {
-        "items": {
-          "additionalProperties": false,
-          "properties": {
-            "count": {
-              "maximum": 9007199254740991,
-              "minimum": -9007199254740991,
-              "type": "integer"
-            },
-            "period": {
-              "description": "Bucket start as an ISO-8601 UTC instant.",
-              "type": "string"
-            }
-          },
-          "required": [
-            "period",
-            "count"
-          ],
-          "type": "object"
-        },
-        "type": "array"
-      },
-      "granularity": {
-        "enum": [
-          "hour",
-          "day",
-          "week",
-          "month"
-        ],
-        "type": "string"
-      },
-      "time_zone": {
-        "type": "string"
-      },
-      "totals": {
-        "additionalProperties": false,
-        "properties": {
-          "count": {
-            "maximum": 9007199254740991,
-            "minimum": -9007199254740991,
-            "type": "integer"
-          }
-        },
-        "required": [
-          "count"
-        ],
-        "type": "object"
-      }
-    },
-    "required": [
-      "data",
-      "totals",
-      "granularity",
-      "time_zone"
-    ],
-    "type": "object"
-  },
-  {
-    "additionalProperties": false,
-    "properties": {
-      "data": {
-        "items": {
-          "additionalProperties": false,
-          "properties": {
-            "click_count": {
-              "maximum": 9007199254740991,
-              "minimum": -9007199254740991,
-              "type": "integer"
-            },
-            "clickthrough_rate": {
-              "description": "click_count / view_count as a percentage.",
-              "type": "number"
-            },
-            "id": {
-              "description": "Subject id for the group_by (UUID; ISO 3166-1 alpha-2 for country).",
-              "type": "string"
-            },
-            "label": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "null"
-                }
-              ]
-            },
-            "view_count": {
-              "maximum": 9007199254740991,
-              "minimum": -9007199254740991,
-              "type": "integer"
-            }
-          },
-          "required": [
-            "id",
-            "label",
-            "view_count",
-            "click_count",
-            "clickthrough_rate"
-          ],
-          "type": "object"
-        },
-        "type": "array"
-      },
-      "pagination": {
-        "additionalProperties": false,
-        "properties": {
-          "has_more": {
-            "type": "boolean"
-          },
-          "limit": {
-            "maximum": 9007199254740991,
-            "minimum": -9007199254740991,
-            "type": "integer"
-          },
-          "page": {
-            "maximum": 9007199254740991,
-            "minimum": -9007199254740991,
-            "type": "integer"
-          },
-          "total_count": {
-            "maximum": 9007199254740991,
-            "minimum": -9007199254740991,
-            "type": "integer"
-          },
-          "total_pages": {
-            "maximum": 9007199254740991,
-            "minimum": -9007199254740991,
-            "type": "integer"
-          }
-        },
-        "required": [
-          "page",
-          "limit",
-          "total_count",
-          "total_pages",
-          "has_more"
-        ],
-        "type": "object"
-      }
-    },
-    "required": [
-      "data",
-      "pagination"
-    ],
-    "type": "object"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "count": {
+              "maximum": 9007199254740991,
+              "minimum": -9007199254740991,
+              "type": "integer"
+            },
+            "period": {
+              "description": "Bucket start as an ISO-8601 UTC instant.",
+              "type": "string"
+            }
+          },
+          "required": [
+            "period",
+            "count"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "granularity": {
+        "enum": [
+          "hour",
+          "day",
+          "week",
+          "month"
+        ],
+        "type": "string"
+      },
+      "time_zone": {
+        "type": "string"
+      },
+      "totals": {
+        "additionalProperties": false,
+        "properties": {
+          "count": {
+            "maximum": 9007199254740991,
+            "minimum": -9007199254740991,
+            "type": "integer"
+          }
+        },
+        "required": [
+          "count"
+        ],
+        "type": "object"
+      }
+    },
+    "required": [
+      "data",
+      "totals",
+      "granularity",
+      "time_zone"
+    ],
+    "type": "object"
+  },
+  {
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "click_count": {
+              "maximum": 9007199254740991,
+              "minimum": -9007199254740991,
+              "type": "integer"
+            },
+            "clickthrough_rate": {
+              "description": "click_count / view_count as a percentage.",
+              "type": "number"
+            },
+            "id": {
+              "description": "Subject id for the group_by (UUID; ISO 3166-1 alpha-2 for country).",
+              "type": "string"
+            },
+            "label": {
+              "anyOf": [
+                {
+                  "anyOf": [
+                    {
+                      "type": "string"
+                    },
+                    {
+                      "additionalProperties": {},
+                      "propertyNames": {
+                        "type": "string"
+                      },
+                      "type": "object"
+                    }
+                  ]
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "Human label: the signature/campaign name, teammate email or country name (the id itself for the events summary's name/country/currency/user). For `anchor`, the link's content node as stored in the signature: an object with `type` (button, socialListItem, textToken…), `href.text` (the URL) or `href.smartFieldUuid` (a smart-field URL), and its visible `text`, `label` or `value` depending on the type. Null when none is available."
+            },
+            "view_count": {
+              "maximum": 9007199254740991,
+              "minimum": -9007199254740991,
+              "type": "integer"
+            }
+          },
+          "required": [
+            "id",
+            "label",
+            "view_count",
+            "click_count",
+            "clickthrough_rate"
+          ],
+          "type": "object"
+        },
+        "type": "array"
+      },
+      "pagination": {
+        "additionalProperties": false,
+        "properties": {
+          "has_more": {
+            "type": "boolean"
+          },
+          "limit": {
+            "maximum": 9007199254740991,
+            "minimum": -9007199254740991,
+            "type": "integer"
+          },
+          "page": {
+            "maximum": 9007199254740991,
+            "minimum": -9007199254740991,
+            "type": "integer"
+          },
+          "total_count": {
+            "maximum": 9007199254740991,
+            "minimum": -9007199254740991,
+            "type": "integer"
+          },
+          "total_pages": {
+            "maximum": 9007199254740991,
+            "minimum": -9007199254740991,
+            "type": "integer"
+          }
+        },
+        "required": [
+          "page",
+          "limit",
+          "total_count",
+          "total_pages",
+          "has_more"
+        ],
+        "type": "object"
+      }
+    },
+    "required": [
+      "data",
+      "pagination"
+    ],
+    "type": "object"
+  }
+]
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower; the description adds real context on defaults (2 months ago → today, UTC), the mutually exclusive timeseries vs. breakdown behavior, and that breakdown rows carry views, clicks, and CTR together. That last point (one call answers the engagement question) is genuine behavioral insight not implied by annotations, though some response-shape detail duplicates the output schema.

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?

Well front-loaded: default behavior first, alternative mode second, filters last. It is dense with inline JSON response sketches that make sentences long, but every sentence carries routing or format information rather than filler.

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 an 11-parameter analytics tool with an output schema, the description covers both modes, defaults, the UTC basis, and the filter set, which is enough for correct invocation. Minor gaps remain: no mention of pagination behavior in the timeseries mode or the anchor breakdown dimension, both of which are discoverable only 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 coverage is 100%, so the baseline is 3. The description explains the semantic interplay of `granularity` vs. `group_by` and the available filters, but it largely restates schema content — and its group_by list ('signature_template | marketing_campaign | teammate | country') silently omits 'anchor', which is in the enum.

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 states a specific verb+resource ('signature-click counts over a date range') and immediately clarifies the two shapes the result can take, so an agent knows exactly what data comes back. It does not name or differentiate itself from the nearest analytics siblings (get_analytics_views, get_analytics_events_summary), relying on the word 'clicks' to do that work implicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear in-tool routing: default timeseries vs. `group_by` ranked breakdown, and even frames the breakdown as answering 'which signature/teammate drives the most engagement'. It stops short of saying when to reach for this tool over get_analytics_views or list_analytics_events, so the cross-tool selection guidance is only implied.

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

All Scribe Mail toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources