SYNOLOGY/MCP.
Install
← Back to overview
◆ Reference

Tool reference.

All 37 MCP tools, every signature, every return shape. Generated from the Zod schemas — what the agent sees is what is documented here.

37 tools
4 modules
JSON-RPC 2.0
Updated 2025-04-30

Overview

Every tool is a typed JSON-RPC method. Inputs and outputs are validated by Zod schemas at the server boundary; clients receive a 422-equivalent error before the call ever reaches Synology.

Tool names follow the convention <module>_<verb>_<object>. The verb encodes the read/write split — list, search, get, read are reads; create, update, delete, send, write, append, label, share, move, mark are writes.

Writes always require an explicit confirm:true argument at the tool boundary. The agent must restate intent before any destructive call lands.

ConventionReads return data. Writes return a small persisted/created envelope. Errors throw — never silent. The agent gets a typed reason, never a 500.

Response envelope

Reads return the data shape directly. Writes return an envelope describing what changed:

// Read response
{ files: [...], truncated: false }
 
// Write response
{ persisted: true, fileId: "f-9a3c2e1b", path: "/team/finance/Q2-tracker.osheet" }
 
// Error response (thrown — never returned)
{ code: "PATH_GUARD_VIOLATION", message: "/etc/passwd is outside DRIVE_ROOT_PATH" }

Error codes

Errors are typed by code. The agent should branch on code, not on message text — message text is human-readable and may change.

CodeMeaningRecoverable
PATH_GUARD_VIOLATIONPath falls outside the configured root prefix.No — fix the path.
CONFIRM_REQUIREDWrite tool called without confirm:true.Yes — restate and retry.
AUTH_EXPIREDSynology session id expired. Server will refresh on next call.Yes — automatic.
NOT_FOUNDResource (file, event, message) does not exist.No.
SYNOLOGY_API_ERRORUpstream Synology REST API returned an error. Inner code carried.Depends on inner code.
VALIDATION_ERRORInput failed Zod validation. Path of failing field included.No — fix the input.
RATE_LIMITEDExceeded MCP_RATE_LIMIT_RPS. Retry-after returned.Yes — back off.

Tool index

Full per-tool detail lives on each module page. This is the cross-module index.

ModuleReadWriteTotal
Drive5611
Spreadsheet5813
MailPlus336
Calendar437
172037

Browse the module pages for individual tool signatures, examples, and confirm-flag requirements.

Move your
NAS forward.

MIT licensed. Open source. Self-hosted from the first byte to the last.

Star on GitHubRead the docs