Skip to main content
Glama

annotate

Draw outlines around page elements by ref or highlight quoted text passages with optional labels, showing users exactly where something is instead of describing its position.

Instructions

Point things out on the page itself: draws an outline around elements (by ref) or highlights a passage (by quoting its text), each with an optional short label. Use this to show the user where something is instead of describing its position. Replaces earlier marks unless keep is true.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "tabId": "<tabId>",
      "marks": "<marks>"
    },
    "name": "annotate"
  }
}

Input Schema

NameRequiredDescriptionDefault
dimNoDarken the rest of the page around the first mark
keepNoKeep existing marks instead of replacing them
marksYes
tabIdYesTab ID, from tabs_list or tab_create

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.8

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the behavioral disclosure. It usefully says marks replace earlier marks unless keep is true and describes the visible result, but it does not cover lifecycle details such as clearing marks, persistence across navigation, or failure behavior.

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 tight sentences front-load the operation, then give the usage rationale and replacement default. Every sentence adds useful information without repetition.

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?

The description plus schema is sufficient to call the tool correctly: it explains the two mark types, optional labels, and default replacement. Remaining gaps are mostly outside the core call path, such as explicit clearing guidance or persistence behavior.

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?

The schema already documents ref, text, label, keep, dim, and tabId, with 75% coverage. The description reinforces the ref-vs-text mode and optional label, but it adds little beyond the schema and does not mention the dim parameter.

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 names a specific action and two concrete mechanisms: outlining elements by ref and highlighting text by quote, each with an optional label. The purpose is unmistakable, but it does not explicitly distinguish this tool from siblings such as clear_annotations or screenshot.

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 a clear when-to-use cue: show the user where something is instead of describing its position. It does not state when not to use it or name a sibling alternative, so it stops 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.