Skip to main content
Glama

add_annotation

Add a manual timeline annotation to a client's AI-visibility project — a dated note ("site relaunch", "TV campaign started") that pins onto the charts so metric movements come with their explanation. Backdate it to the day the thing happened. By default the note is internal (team-only); set showInReports:true to make it visible on shared report charts too. Requires MCP write actions; without confirm:true it returns a preview.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dateNoISO date the event happened (e.g. "2026-09-01") — backdating is the normal case. Defaults to today.
textYesThe note (max 500 characters).
confirmNoSet true to apply. Omit for a preview. With confirm:true, also pass the preview's previewToken.
clientIdNoClient id (from list_clients) — uses the AI-Visibility project its Overview opens in the app (the newest).
projectIdNoAI-visibility project id — alternative to clientId.
previewTokenNoWith confirm:true: the previewToken from this tool's preview (valid 15 minutes, once, for exactly the previewed arguments).
showInReportsNotrue → visible on shared report charts (visibility "shared"). Default false → internal, team-only.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false, openWorldHint=false), the description discloses the two-step write flow: 'Requires MCP write actions; without confirm:true it returns a preview.' It also discloses the visibility default ('internal, team-only' unless showInReports:true). These are behavioral traits not captured by the annotations.

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?

Front-loaded with the core purpose, then backdating guidance, then visibility default, then the confirm requirement — each sentence earns its place with no filler. Dense but efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no output schema, the description covers what gets created, the preview/confirm workflow, the visibility behavior, and the write-action requirement. Nothing essential for calling it correctly 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 workflow-level meaning: it frames confirm/previewToken as a sequence (preview then apply) and reinforces the showInReports default semantics. It adds value beyond the schema without fully redefining parameter syntax.

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?

States a specific verb ('Add') plus resource ('manual timeline annotation') scoped to a client's AI-visibility project, and elaborates with a concrete example ('site relaunch', 'TV campaign started') so the agent knows exactly what artifact this creates. It is clearly distinct from sibling add_* tools (add_market, add_widget, add_tracking_prompt).

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?

The description gives clear usage context — use it to pin explanations onto charts so metric movements are explained, and it says to backdate to the day the event happened. It does not name any alternative tool or state when NOT to use it, so it falls short of the explicit when/when-not/alternatives bar.

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.

Resources