Skip to main content
Glama

get_highlight

Read-only

Fetch full highlight details—description, segments (ticks, POV, speed, caption), kill ticks, and renders—to review before editing.

Instructions

Full highlight: description, every segment (ticks, POV, speed, caption), kill ticks and all its renders. Read this before editing.

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": {
      "highlight_id": "<highlight_id>"
    },
    "name": "get_highlight"
  }
}

Input Schema

NameRequiredDescriptionDefault
highlight_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds useful behavioral context by implying this is the heavy, full-fat read relative to other fetches and by framing it as a prerequisite to editing. It says nothing about payload size, behavior when the id does not exist, or cost of pulling all renders.

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?

Roughly twenty words, front-loaded with what is returned before the workflow advice, with zero filler. The telegraphic sentence fragments trade a little readability for density but cost nothing in clarity.

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?

An output schema exists, so return shapes need no prose, yet the description still usefully enumerates the payload sections. For a single-parameter read tool with declared safety annotations, the only real gap is where highlight_id comes from, which is minor.

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?

There is a single parameter with 0% schema description coverage, so the description carries the full burden and gives no clarification of highlight_id's expected format or source. The parameter name is largely self-explanatory, which keeps this at a minimum-viable 3 rather than lower.

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 the resource and enumerates the payload concretely: description, every segment (ticks, POV, speed, caption), kill ticks, and all renders. That distinguishes it clearly from a summary-style 'list_highlights' or a mutating 'edit_highlight', though the retrieval verb itself is only implied by the tool name rather than stated.

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?

'Read this before editing' establishes one concrete workflow link to the editing sibling, which is genuine when-to-use guidance. It offers no exclusions, no mention of how highlight_id is obtained (e.g., via list_highlights), and no indication of when a lighter fetch would suffice.

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