Get highlights
get_highlightsGet all text highlights from an article.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| article_id | Yes | The article ID. |
get_highlightsGet all text highlights from an article.
| Name | Required | Description | Default |
|---|---|---|---|
| article_id | Yes | The article ID. |
Changes observed during successful MCP inspections.
No schema history has been recorded yet.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered without the description. The description's only added context is the word 'all' and 'text' (as opposed to notes or other annotation types), which is thin behavioral value.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single short sentence with the resource and scope front-loaded; there is no filler or redundancy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple single-parameter read tool whose annotations carry the full safety profile, the description is essentially complete and does indicate what is returned (all text highlights). It could note return shape or empty-result behavior, but no output schema exists so this is a minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With one parameter at 100% schema description coverage, the schema already documents article_id. The description adds no format, ID syntax, or behavioral detail beyond what the schema provides, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb and resource: retrieve all text highlights belonging to a given article. It implicitly distinguishes itself from get_notes (different resource) and add_highlight/remove_highlight (different operations), but never names or contrasts those siblings explicitly.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool versus alternatives such as get_notes or get_article. Usage is only weakly implied by the phrase 'from an article' and by the required article_id parameter; no prerequisites or exclusions are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.