Skip to main content
Glama

Staats

Record annotation

record_annotation

Mark a moment on a site timeline: a deploy, a content change, or a campaign start. Call this every time you ship a change to the site. ts defaults to now. Write a specific, present-tense description ("Shipped new pricing page hero", never "updates"), one annotation per meaningful change. When known, include commit and the routes the change touched so compare_around can also report before/after traffic scoped to those routes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tsNoISO timestamp of the change; defaults to now
siteNothe site's data-site code, from its script tag or list_sites. Omit when the account has a single site. In a tracked project, read the code from the script tag before asking the user.
textYesspecific, present-tense description of the change
commitNogit commit hash of the deploy (7-40 hex chars)
routesNoroute prefixes the change touched, e.g. ['/docs', '/pricing'] ('/docs' covers '/docs/*')

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
tsYes
metaNo
siteYes
textYes
recordedYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

The description makes the side effect clear (a write to the site timeline) and adds behavioral guardrails not in the annotations: one annotation per meaningful change, and commit/routes feeding compare_around's before/after reporting. Annotations already flag idempotent=false and destructive=false, so there is no contradiction.

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?

Three short sentences with no filler; the first states purpose, the second gives the trigger and style rules, and the third explains optional parameters. All information is front-loaded and earns its place.

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?

With full schema coverage and an output schema present, the description covers the core decision points: when to call, how to phrase text, and when to enrich with commit/routes. It could add an explicit alternative/exclusion hint, but nothing necessary for correct invocation is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/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, but the description adds semantic value by explaining why commit and routes matter (they let compare_around scope before/after traffic) and by reinforcing text formatting. It does not substantially add to site or ts, but the overall contribution moves it above baseline.

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?

The description uses a specific verb-resource pair ('Mark a moment on a site timeline') and concrete examples (deploy, content change, campaign start), plus an explicit trigger ('Call this every time you ship a change'). This clearly differentiates it from read/report siblings like list_annotations and compare_around.

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 provides a crisp when-to-use rule: every time a change is shipped, and it adds practical conventions (present-tense text, one annotation per meaningful change, include commit/routes when known). It does not explicitly list when-not-to-use or name alternatives, so it falls just short of full routing guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.9/5.0
Disambiguation4/5

Most tools target clearly distinct resources or analytic questions: site CRUD, annotation handling, overviews, funnels, journeys, and diagnostic checks are separated. A few tools like get_overview, query, and what_changed could overlap when asking 'what happened', but their descriptions differentiate the intended use well.

Naming Consistency3/5

The CRUD tools follow a clean verb_noun pattern (create_site, delete_site, list_sites, update_site_context), but analysis tools mix bare nouns (funnel, journeys), bare verbs (query), adverb-verb compounds (compare_around), and what_* question phrases (what_broke, what_changed). Naming is readable and snake_case is consistent, but the overall convention is not uniform.

Tool Count5/5

15 tools is within the well-scoped range and each tool earns its place: site management, annotation tracking, traffic overview, discovery, diagnostics, and comparison all have dedicated tools. There is no obvious redundancy or padding.

Completeness4/5

The surface covers the core domain well: sites can be created, listed, deleted, and contextualized; annotations can be recorded and listed; analytics support overview, breakdown, funnel, journey, and anomaly questions. Minor gaps exist such as no update/delete for annotations and no single-site getter separate from list_sites, but agents can work around these.