Skip to main content
Glama
inkdropapp

Inkdrop MCP Server

Official
by inkdropapp
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

update-book

Update an existing notebook's fields by providing its ID and the changes. Only specified fields are modified, leaving others untouched, so no prior read is required.

Instructions

Update the existing notebook in the database. Only the fields you provide will be updated; omitted fields remain unchanged, so you do not need to read the notebook first. Call list-notebooks or read-book to find the notebook ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
_idYesThe unique document ID which should start with `book:` and the remains are randomly generated string
_revNoThis is a CouchDB specific field. The current MVCC-token/revision of this document. Optional: the server merges your fields into the stored notebook, so it is only needed as an optimistic-concurrency guard. Pass it when you have read the notebook first and want the update to fail on a conflicting concurrent edit.
nameNoThe notebook name
parentBookIdNoThe ID of the parent notebook. Pass `null` to move the notebook to the root level.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.5.0

TDQS

A4/5.0
Behavior3/5

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

The description explains the partial-update behavior and implicitly relies on the schema for the _rev optimistic-concurrency guard. However, it does not mention what happens if the notebook does not exist, what the tool returns, or any side effects beyond updating fields, leaving some behavioral ambiguity.

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?

The description is concise and well-structured, using two sentences to state the purpose, explain partial-update semantics, and provide ID-lookup guidance. No unnecessary words or redundant details are present.

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?

Given the schema fully documents parameters and no output schema is provided, the description covers the essential usage context. It could mention return behavior or error cases, but the core agent-facing needs—what to update, how partial updates work, and how to find the ID—are adequately addressed.

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 covers all four parameters with detailed descriptions, including the meaning of _rev, name, and parentBookId null semantics. The tool description adds little parameter-specific meaning beyond reiterating that omitted fields remain unchanged, so it does not significantly elevate understanding beyond the schema.

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 clearly states the tool updates an existing notebook in the database and indicates partial-field updating. Minor terminology inconsistency exists between the tool name 'update-book' and the description's repeated use of 'notebook,' which could confuse agents, but the core purpose remains unambiguous.

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

Usage Guidelines5/5

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

The description provides concrete guidance: only provided fields are updated, omitted fields remain unchanged, and reading the notebook beforehand is unnecessary. It also directs the agent to list-notebooks or read-book to find the notebook ID, giving clear actionable context for when and how to use the tool.

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

Deploy Server

Other Tools