Obsidian Server MCP

Overview Schema Source Related Servers Discussions Admin

vault_read_binary

Read-onlyIdempotent

Retrieve images and non-PDF attachments from an Obsidian vault as a raster preview, signed HTTPS download link, or raw bytes up to 4 MiB.

Instructions

Read images and non-PDF attachments. auto: raster preview or signed HTTPS download link. bytes: original data up to 4 MiB. PDF is unsupported in every mode; use the client's native file upload/attachments.

Input Schema

Name	Required	Description	Default
`as`	No
`path`	Yes

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.2.0Oct 24, 2026

addedOutput schema / anyOf

Added value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "delivery": {
+        "const": "image",
+        "type": "string"
+      },
+      "firstFrameOnly": {
+        "type": "boolean"
+      },
+      "height": {
+        "exclusiveMinimum": 0,
+        "maximum": 9007199254740991,
+        "type": "integer"
+      },
+      "mimeType": {
+        "type": "string"
+      },
+      "outputMimeType": {
+        "const": "image/webp",
+        "type": "string"
+      },
+      "outputSizeBytes": {
+        "maximum": 9007199254740991,
+        "minimum": 0,
+        "type": "integer"
+      },
+      "path": {
+        "type": "string"
+      },
+      "preview": {
+        "const": true,
+        "type": "boolean"
+      },
+      "sizeBytes": {
+        "maximum": 9007199254740991,
+        "minimum": 0,
+        "type": "integer"
+      },
+      "version": {
+        "pattern": "^sha256:[0-9a-f]{64}$",
+        "type": "string"
+      },
+      "versionGuard": {
+        "maxLength": 16,
+        "minLength": 16,
+        "pattern": "^[0-9a-f]{16}$",
+        "type": "string"
+      },
+      "width": {
+        "exclusiveMinimum": 0,
+        "maximum": 9007199254740991,
+        "type": "integer"
+      }
+    },
+    "required": [
+      "path",
+      "mimeType",
+      "sizeBytes",
+      "version",
+      "versionGuard",
+      "delivery",
+      "outputMimeType",
+      "outputSizeBytes",
+      "width",
+      "height",
+      "preview",
+      "firstFrameOnly"
+    ],
+    "type": "object"
+  },
+  {
+    "additionalProperties": false,
+    "properties": {
+      "delivery": {
+        "const": "bytes",
+        "type": "string"
+      },
+      "mimeType": {
+        "type": "string"
+      },
+      "path": {
+        "type": "string"
+      },
+      "sizeBytes": {
+        "maximum": 9007199254740991,
+        "minimum": 0,
+        "type": "integer"
+      },
+      "uri": {
+        "type": "string"
+      },
+      "version": {
+        "pattern": "^sha256:[0-9a-f]{64}$",
+        "type": "string"
+      },
+      "versionGuard": {
+        "maxLength": 16,
+        "minLength": 16,
+        "pattern": "^[0-9a-f]{16}$",
+        "type": "string"
+      }
+    },
+    "required": [
+      "path",
+      "mimeType",
+      "sizeBytes",
+      "version",
+      "versionGuard",
+      "delivery",
+      "uri"
+    ],
+    "type": "object"
+  },
+  {
+    "additionalProperties": false,
+    "properties": {
+      "delivery": {
+        "const": "link",
+        "type": "string"
+      },
+      "expiresAt": {
+        "type": "string"
+      },
+      "mimeType": {
+        "type": "string"
+      },
+      "path": {
+        "type": "string"
+      },
+      "reason": {
+        "enum": [
+          "requested",
+          "download",
+          "too_large",
+          "image_preview_unavailable"
+        ],
+        "type": "string"
+      },
+      "sizeBytes": {
+        "maximum": 9007199254740991,
+        "minimum": 0,
+        "type": "integer"
+      },
+      "uri": {
+        "type": "string"
+      },
+      "version": {
+        "pattern": "^sha256:[0-9a-f]{64}$",
+        "type": "string"
+      },
+      "versionGuard": {
+        "maxLength": 16,
+        "minLength": 16,
+        "pattern": "^[0-9a-f]{16}$",
+        "type": "string"
+      }
+    },
+    "required": [
+      "path",
+      "mimeType",
+      "sizeBytes",
+      "delivery",
+      "uri",
+      "expiresAt",
+      "reason",
+      "version",
+      "versionGuard"
+    ],
+    "type": "object"
+  },
+  {
+    "additionalProperties": false,
+    "properties": {
+      "delivery": {
+        "const": "link",
+        "type": "string"
+      },
+      "expiresAt": {
+        "type": "string"
+      },
+      "mimeType": {
+        "type": "string"
+      },
+      "path": {
+        "type": "string"
+      },
+      "reason": {
+        "enum": [
+          "requested",
+          "download",
+          "too_large",
+          "image_preview_unavailable"
+        ],
+        "type": "string"
+      },
+      "sizeBytes": {
+        "maximum": 9007199254740991,
+        "minimum": 0,
+        "type": "integer"
+      },
+      "uri": {
+        "type": "string"
+      }
+    },
+    "required": [
+      "path",
+      "mimeType",
+      "sizeBytes",
+      "delivery",
+      "uri",
+      "expiresAt",
+      "reason"
+    ],
+    "type": "object"
+  }
+]

removedOutput schema / oneOf

Removed value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "delivery": {
-        "const": "image",
-        "type": "string"
-      },
-      "firstFrameOnly": {
-        "type": "boolean"
-      },
-      "height": {
-        "exclusiveMinimum": 0,
-        "maximum": 9007199254740991,
-        "type": "integer"
-      },
-      "mimeType": {
-        "type": "string"
-      },
-      "outputMimeType": {
-        "const": "image/webp",
-        "type": "string"
-      },
-      "outputSizeBytes": {
-        "maximum": 9007199254740991,
-        "minimum": 0,
-        "type": "integer"
-      },
-      "path": {
-        "type": "string"
-      },
-      "preview": {
-        "const": true,
-        "type": "boolean"
-      },
-      "sizeBytes": {
-        "maximum": 9007199254740991,
-        "minimum": 0,
-        "type": "integer"
-      },
-      "version": {
-        "pattern": "^sha256:[0-9a-f]{64}$",
-        "type": "string"
-      },
-      "width": {
-        "exclusiveMinimum": 0,
-        "maximum": 9007199254740991,
-        "type": "integer"
-      }
-    },
-    "required": [
-      "path",
-      "mimeType",
-      "sizeBytes",
-      "version",
-      "delivery",
-      "outputMimeType",
-      "outputSizeBytes",
-      "width",
-      "height",
-      "preview",
-      "firstFrameOnly"
-    ],
-    "type": "object"
-  },
-  {
-    "additionalProperties": false,
-    "properties": {
-      "delivery": {
-        "const": "bytes",
-        "type": "string"
-      },
-      "mimeType": {
-        "type": "string"
-      },
-      "path": {
-        "type": "string"
-      },
-      "sizeBytes": {
-        "maximum": 9007199254740991,
-        "minimum": 0,
-        "type": "integer"
-      },
-      "uri": {
-        "type": "string"
-      },
-      "version": {
-        "pattern": "^sha256:[0-9a-f]{64}$",
-        "type": "string"
-      }
-    },
-    "required": [
-      "path",
-      "mimeType",
-      "sizeBytes",
-      "version",
-      "delivery",
-      "uri"
-    ],
-    "type": "object"
-  },
-  {
-    "additionalProperties": false,
-    "properties": {
-      "delivery": {
-        "const": "link",
-        "type": "string"
-      },
-      "expiresAt": {
-        "type": "string"
-      },
-      "mimeType": {
-        "type": "string"
-      },
-      "path": {
-        "type": "string"
-      },
-      "reason": {
-        "enum": [
-          "requested",
-          "download",
-          "too_large",
-          "image_preview_unavailable"
-        ],
-        "type": "string"
-      },
-      "sizeBytes": {
-        "maximum": 9007199254740991,
-        "minimum": 0,
-        "type": "integer"
-      },
-      "uri": {
-        "type": "string"
-      },
-      "version": {
-        "pattern": "^sha256:[0-9a-f]{64}$",
-        "type": "string"
-      }
-    },
-    "required": [
-      "path",
-      "mimeType",
-      "sizeBytes",
-      "delivery",
-      "uri",
-      "expiresAt",
-      "reason"
-    ],
-    "type": "object"
-  }
-]

First observedv0.1.0Oct 3, 2026

TDQS

A3.7/5.0

Behavior4/5

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

The annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false. The description adds useful behavior beyond annotations: the 4 MiB limit for bytes mode, the preview-or-link behavior of auto mode, and the PDF exclusion.

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 short, front-loaded, and every sentence carries operational value: supported file type, mode behavior, size limit, and PDF exclusion. There is no wasted text.

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?

The output schema exists, so return values need not be explained, and annotations cover safety traits. However, with zero schema parameter descriptions, the missing link mode and unexplained path parameter leave the definition only partially complete for correct invocation.

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?

With 0% schema description coverage, the description must fully explain the parameters. It describes auto and bytes modes, but omits the link enum value entirely, and it does not explain the required path parameter. This leaves a significant gap in mode selection semantics.

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 states a specific verb and resource: read images and non-PDF attachments. It clearly excludes PDFs, but it does not explicitly distinguish this tool from sibling vault_read for text files. The purpose is still clear and actionable.

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 gives clear context for when to use this tool versus native file handling, especially by stating that PDFs are unsupported in every mode. It also explains the auto and bytes modes, though it does not explicitly route text reads to vault_read.

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

Deploy Server