Skip to main content
Glama
inkdropapp

Inkdrop MCP Server

Official
by inkdropapp
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

read-file

Retrieves an attachment by ID, returning its metadata and image content for PNG/JPEG/GIF. Use outputPath to save non-displayable attachments to disk.

Instructions

Retrieve an attachment file by its ID. Returns the file metadata, and the image itself when it is a PNG, JPEG or GIF. Pass outputPath to write the attachment to disk instead — required to get at SVG, HEIC and HEIF attachments, which cannot be displayed inline.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileIdYesID of the attachment to retrieve. It can be found as `_id` in the file docs. It always starts with `file:`.
outputPathNoAbsolute path to write the attachment to. When given, the file is saved there and its bytes are not returned inline.
includeImageNoWhether to return the image itself alongside the metadata. Set to false to fetch only the metadata of a large attachment.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.5.0

TDQS

A4.7/5.0
Behavior5/5

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

The description discloses behavioral details such as writing to disk when outputPath is provided, the ability to return metadata only, and the limitation that certain formats cannot be displayed inline. This is comprehensive given no annotations are provided.

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, consisting of two clear sentences that front-load the main purpose and include necessary usage details without excess.

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

Completeness5/5

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

The description provides enough context for an agent to understand when and how to use the tool, including edge cases for file formats and metadata-only retrieval. It does not require an output schema to be complete.

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

Parameters4/5

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

The input schema covers all three parameters with descriptions, and the tool description adds extra context about their purposes, such as the requirement for outputPath for certain file types and includeImage for large attachments.

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?

The description clearly states the tool retrieves an attachment file by its ID, which is a specific verb and resource. It also distinguishes itself from sibling tools that deal with notes, books, and tags.

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?

The description provides usage guidance by explaining when to use outputPath (for SVG, HEIC, HEIF) and when to set includeImage to false for large attachments. However, it does not explicitly compare with alternative tools, but the context makes it clear.

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