Skip to main content
Glama

create_highlight

Highlight words in a space with a marker, as the viewer's Highlight button does: a new version, shown on open tabs.

Input Schema

NameRequiredDescriptionDefault
colorNoThe marker's ink for all of them; yellow when left out. (one of yellow, green, pink, blue, orange, purple)
spaceNoThe space: its link, @handle/slug or uuid. Needs edit rights on a static page. (space name)
space_idNo`space` by its id, instead of its name. (space id)
highlightsYesThe words to mark, and where: 1 to 20, each its own mark. A run of them is one "Highlights" line in the history. (list of highlights)

Output Schema

NameRequiredDescriptionDefault
urlNo
failedNo
stoppedNo
highlightsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (not read-only, not destructive, not idempotent), and the description adds real behavioral context beyond them: this creates 'a new version' and is 'shown on open tabs', telling the agent the call has a visible side effect on other viewers. It stops short of stating required permissions or limits on repeated calls.

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?

A single tight sentence with the action front-loaded and the behavioral consequence appended after the colon. No filler, nothing redundant.

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, an output schema, and annotations present, the description covers what is needed to invoke the tool and notes the version-creation side effect. The remaining gap is sibling disambiguation against highlight_text, which matters for a tool family this crowded.

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 description coverage is 100%, so the schema already explains color defaults, the space/space_id alternative, and the text/after/before/block disambiguation fields in detail. The description adds nothing about parameters, so the baseline 3 applies.

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 verb (highlight) and resource (words in a space) and ties it to a concrete analog ('as the viewer's Highlight button does'). It is clear on its own, but it never distinguishes itself from the sibling tool highlight_text, which sounds functionally identical, leaving the agent to guess which one to call.

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?

Usage is only implied: the viewer-button analogy suggests 'use when a reader would press Highlight'. There is no explicit when-to-use vs when-not, no mention of prerequisites such as edit rights, and no routing to highlight_text or delete_highlight for related operations.

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