Skip to main content
Glama
synology-mcp
by r03eRt

Read file

read_file
Read-only

Fetch a file from a Synology NAS as text or image, enforcing a max_bytes limit to block oversized reads.

Instructions

Read a file from the NAS and return its content: text files as text, images (png/jpg/gif/webp) as an image. Refuses files larger than max_bytes.

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": {
      "path": "<path>"
    },
    "name": "read_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
max_bytesNoSize limit in bytes (default 1 MB)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.7.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and closed-world behavior, so the safety profile is covered. The description adds genuinely new behavior: content is returned in-band and typed by file kind, and oversized files are refused rather than truncated — a distinction the schema's 'Size limit' wording does not make.

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?

Two sentences, front-loaded with the resource and return behavior, with the size constraint last. No filler and nothing repeated from the annotations.

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?

A read-only two-parameter tool with annotations and no output schema needs only to explain the return shape and limits, both of which are present. The remaining gap is the failure mode for a refused oversized file (error vs. empty result) and the absolute-path requirement.

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?

With only 50% schema description coverage, the 'path' parameter is documented only by a regex pattern, and the description does not state that it must be an absolute NAS path. It does add useful semantics for max_bytes (exceeding it causes refusal, 1 MB default implied by 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?

States a specific verb and resource ('Read a file from the NAS') and clarifies the return modality (text vs. image), which an agent cannot infer from the name alone. It does not differentiate itself from the nearby 'download_file' sibling, so it stops short of a 5.

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 guidance and no routing away from 'download_file' or 'get_file_info', even though the sibling list makes those plausible alternatives for the same resource. The size-limit sentence is a constraint, not usage guidance.

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