Skip to main content
Glama
devonthink3-mcp
by waylake

dt3_get_records

Read-onlyIdempotent

Read metadata and edit revisions for up to 100 DEVONthink records in one call, returning per-record errors without failing the batch. Use it to inventory groups without repeated single-record calls.

Instructions

Read metadata and edit revisions for up to 100 records in one call. Per-record failures are returned in errors instead of failing the batch. Prefer this over repeated dt3_get_record calls when inventorying a group.

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": {
      "uuids": "<uuids>"
    },
    "name": "dt3_get_records"
  }
}

Input Schema

NameRequiredDescriptionDefault
uuidsYes
include_custom_metadataNo

Output Schema

NameRequiredDescriptionDefault
errorsYes
recordsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.3.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds genuinely non-obvious behavior: partial failure semantics, where per-record failures come back in `errors` rather than aborting the batch. It does not discuss ordering or the shape of the returned revision data, keeping it short of a 5.

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?

Three short sentences with the capability, the failure behavior, and the sibling routing in that order — front-loaded and free of filler.

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 values need no explanation, and the description covers the batch limit and partial-failure contract well. The remaining gap is the undocumented `include_custom_metadata` flag, which an agent would have to discover from the schema alone.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must carry parameter meaning, and it only partly does: it establishes the 100-record ceiling on `uuids`. The second parameter, `include_custom_metadata`, is never mentioned, and the accepted UUID / x-devonthink-item:// link forms go unexplained in the description text.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (read metadata and revisions for records) plus a bounded batch scope of up to 100, and explicitly identifies the sibling it replaces (repeated dt3_get_record calls). An agent can distinguish it from dt3_get_record and dt3_read_texts without opening any schema.

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

Usage Guidelines4/5

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

Gives a clear selection rule: prefer this over repeated dt3_get_record calls when inventorying a group. It does not state when *not* to use it (e.g. single-record lookups), but the positive routing guidance is unambiguous.

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