Synology ActiveProtect Manager MCP server
Commit Nov 14, 2026Enables AI agents to manage Synology APM operations including backups, restores, protection plans, and workload monitoring.
Also known as synology-apm/apm-sdk-python
- Stars
- 3
- Tools
- —
- Downloads, 30 days
- —
- Latest version
- —
- Last commit
- Nov 14, 2026
- License
- Apache-2.0
What is Synology ActiveProtect Manager MCP?
Synology ActiveProtect Manager enables AI agents to manage Synology APM operations including backups, restores, protection plans, and workload monitoring.
Summary generated from the project's README
About Synology ActiveProtect Manager MCP server
Managing Synology ActiveProtect Manager operations through an AI agent is possible with this MCP server. It allows users to connect tools to clients like Claude Desktop or ChatGPT Desktop to handle backups, restores, and protection plans. The server also provides access to M365 and GWS workloads, infrastructure details, and system logs.
Developers use this server to give agents specific workflow skills, such as generating daily backup reports or investigating failures. It functions as an interface to the APM REST API, providing a way to monitor workloads and analyze storage capacity. The setup requires configuring environment variables and choosing between different operation modes for your agent.
This implementation is built on an async-native Python SDK that supports multiple APM versions. By using the synology-apm-mcp package, you can transform complex data management tasks into conversational commands. It serves as a bridge between high-level AI reasoning and low-level infrastructure management for Synology ActiveProtect Appliance users.
What you can do with it
- 1Investigate backup failuresAsk your AI agent to look through system logs to find the cause of a failed backup job.
- 2Generate daily reportsInstruct the agent to create a summary of the previous day's backup activities.
- 3Analyze storage usageRequest a detailed breakdown of how much storage capacity is currently being used by your workloads.
- 4Manage protection plansUse the agent to modify or create new protection plans for your data workloads.
Written from the project's README. Every use case is checked against a quote from it.
Automated checks
Ran Nov 15, 2026Full report →Not verified yet. A server needs a score of 80, no serious finding, and enough data for us to check. How checks work · What to fix for more points
- Source repository linked and reachablesynology-apm/apm-sdk-python is public and reachablegithub.com/synology-apm/apm-sdk-python ↗Pass
- Package names this repository as its sourceNot checked
- Build provenance (Sigstore attestation)Not checked
- Open source license (OSI)Apache-2.0spdx.org/licenses/Apache-2.0.html ↗Pass
- Commit or release in the last yearLast commit or release 2026-11-14github.com/synology-apm/apm-sdk-python ↗Pass
- OpenSSF ScorecardNot checked
- Package name not close to a popular packageNot checked
- No critical advisory in the package or its dependenciesNot checked
- No hidden instructions to the model0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersPass
- Destructive tools are labelledNot checked
- Remote endpoint answers the MCP handshakeNot checked
README
View on GitHubSynology ActiveProtect Manager (APM) — Python SDK, CLI & MCP Server
Python SDK, command-line tool, and MCP server for Synology ActiveProtect Manager (APM).
Prerequisites
Pick whichever matches the install method you use below — you don't need both:
uv— provisions Python automatically and powers theuvx/uv tool/uv addcommands below; see the installation instructions for macOS, Windows, and Linuxpip— usually bundled with your Python installation; see the installation instructions if you need to install it separately- Python 3.11 or later (provisioned automatically when using
uv/uvx; required on your own interpreter for a plainpip install)
Compatibility
This SDK release supports multiple APM versions — see the SDK design contract's "APM Version Compatibility" section for the supported versions and how cross-version differences are handled.
AI Agent Integration (MCP Server)
synology-apm-mcp exposes APM operations — backups, restores, protection plans, M365 and GWS workloads, infrastructure, activities, and logs — as Model Context Protocol tools for AI agents such as Claude Desktop and ChatGPT Desktop, plus workflow skills that teach agents domain goals (daily backup reports, storage capacity analysis, failure investigation, and more).
Install the MCP Server
See packages/synology-apm-mcp/README.md for the full setup guide — Claude Desktop, ChatGPT Desktop, environment variables, operation modes, and audit logging.
CLI
synology-apm-cli operates APM directly from your terminal — protection plans, backup/restore operations, infrastructure, activities, and logs.
Install the CLI
Run directly without installing:
uvx synology-apm-cli --help
Or install with pip:
pip install synology-apm-cli
synology-apm-cli --help
CLI Quick Start
synology-apm-cli config set # set up default credentials
synology-apm-cli infra info
Full CLI Command Reference
See packages/synology-apm-cli/README.md for authentication options, output formats, and the full command reference.
Developer Guide
Building your own automation on top of the SDK, or contributing to this repo? Start here.
SDK
synology-apm-sdk is the async-native, fully typed Python interface to the APM REST API that both the CLI and MCP server are built on.
Install the SDK
uv add synology-apm-sdk # inside a uv project
pip install synology-apm-sdk # any other environment
See packages/synology-apm-sdk/README.md for the Quick Start, full data model, and usage examples.
This repo is a uv workspace publishing three PyPI packages
(synology-apm-sdk, synology-apm-cli, synology-apm-mcp) from shared source, plus skills/
(MCP workflow skills), examples/, and docs/ (Sphinx source) — see CLAUDE.md
for the dev workflow.
Install From Source (Contributing)
git clone https://github.com/synology-apm/apm-sdk-python.git
cd apm-sdk-python
# Install all three packages editable, plus dev tools (pytest, mypy, ruff, etc.)
uv sync
# Run the CLI
uv run synology-apm-cli config set # set up default credentials
See CLAUDE.md for the development guide (code conventions, Post-change Checklist)
and CONTRIBUTING.md for example-data conventions; see the Makefile for
available commands (tests, linting, type checking, docs, skills generation).
API Reference
The full SDK API reference (every public class, method, and type signature) is generated from source with Sphinx and published at:
https://synology-apm.github.io/apm-sdk-python/
To build it locally instead (e.g. to preview docstring changes):
uv sync --group docs # first time only
make docs
Then open docs/_build/html/index.html in your browser.
Documentation Index
| Document | Description |
|---|---|
CONTRIBUTING.md |
Example-data conventions (canonical placeholder values for docstrings, examples, and test fixtures) |
APM_PRODUCT_OVERVIEW.md |
APM product/domain knowledge: workload categories, protection plans, backup copy, and other core concepts |
packages/synology-apm-cli/README.md |
CLI command reference — authentication, output formats, full command list |
packages/synology-apm-mcp/README.md |
MCP server guide — Claude Desktop / ChatGPT Desktop setup, operation modes, available tools and workflow skills |
packages/synology-apm-sdk/README.md |
SDK developer guide — quick start and usage examples for every module |
| API Reference | Full SDK API reference — every public class, method, and type signature (Sphinx, hosted on GitHub Pages) |
examples/README.md |
Example automation scripts (inventory, reports, bulk import/export, …) |
CLAUDE.md |
Development guide — code conventions and the Post-change Checklist |
Synology ActiveProtect Manager MCP questions
What can the MCP server do?
It exposes APM operations like backups, restores, protection plans, M365 and GWS workloads, infrastructure, activities, and logs as tools for AI agents.