Skip to main content
Glama
Karakeep MCP server

Karakeep MCP server

by karakeep-app

update-highlight

Modify a highlight's color or note by highlight ID, including clearing the note when needed.

Instructions

Update a highlight's color or note.

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": {
      "highlightId": "<highlightId>"
    },
    "name": "update-highlight"
  }
}

Input Schema

NameRequiredDescriptionDefault
noteNoNew note. Pass null to clear it.
colorNoNew highlight color.
highlightIdYesThe id of the highlight to update.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.35.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / properties / note / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedInput schema / properties / note / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Addedv0.33.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare a non-read-only, non-destructive mutation, so the safety profile is covered, and "update" is consistent with them. The description contributes nothing further — it does not say whether omitted fields are left untouched (partial vs. full update), what happens for an unknown id, or that the operation is idempotent. Minor credit for the "color or note" phrasing hinting at optional per-field updates.

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?

A single front-loaded sentence with zero filler, well matched to a three-parameter tool. It is arguably too terse for its stakes, but no sentence is wasted.

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

Completeness3/5

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

For a simple mutation with full schema coverage and annotations present, the essentials are there. The missing piece an agent would actually want — whether unspecified fields are preserved vs. reset — is not stated anywhere, and there is no output schema to clarify the returned highlight.

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%: highlightId, color (with enum), and note (with the "pass null to clear it" contract) are all documented in the schema itself. The description merely restates the two mutable field names and adds no format, enum, or clearing semantics beyond the schema, so 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?

States a specific verb and resource ("Update a highlight") plus the two mutable fields (color, note), which lets an agent separate it from update-bookmark/update-list/update-tag by resource. It stops short of any explicit sibling comparison, so it lands at a clear-but-undifferentiated 4.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use or when-not-to-use guidance: nothing says this applies only to existing highlights, or that create-highlight/delete-highlight are the alternatives for other intents. The intent to modify an existing highlight is only implied by the verb.

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