mcp-server-syncthing
Provides tools for monitoring and controlling Syncthing via its REST API, including getting system status, listing and checking folders and devices, viewing connection status, and triggering folder scans.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@mcp-server-syncthing show me the Syncthing system status"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
MCP Server for Syncthing
MCP (Model Context Protocol) server providing tools for controlling and monitoring Syncthing via its REST API.
Features
Monitoring Tools
syncthing_get_status- Get overall system status (version, uptime, system info)syncthing_list_folders- List all configured folders with IDs, labels, and pathssyncthing_get_folder_status- Get detailed folder status (sync state, errors, byte counts)syncthing_get_folder_errors- Get list of errors for a specific foldersyncthing_get_file_info- Get file information (local vs global versions)syncthing_list_devices- List all configured devicessyncthing_get_connections- Get current connection status for all devices
Control Tools
syncthing_scan_folder- Trigger folder/subfolder scan to detect changes
Related MCP server: mcp-homeassistant
Installation
1. Install Dependencies
cd ~/mcp-servers/syncthing
npm install
npm run build2. Set System Environment Variables
Option A: System-wide (Recommended)
Add to /etc/environment:
SYNCTHING_API_KEY="your-api-key-here"
SYNCTHING_API_URL="http://localhost:8384"Then logout/login for changes to take effect.
Option B: User profile
Add to ~/.profile (NOT ~/.bashrc):
export SYNCTHING_API_KEY="your-api-key-here"
export SYNCTHING_API_URL="http://localhost:8384"Then logout/login for changes to take effect.
Note: ~/.bashrc only works for terminal sessions, not GUI apps like Claude Desktop.
To find your API key:
Open Syncthing web UI (usually http://localhost:8384)
Go to Actions > Settings > General
Copy the API Key
3. Configure Claude Desktop
Add to ~/.config/claude/claude_desktop_config.json:
{
"mcpServers": {
"syncthing": {
"command": "node",
"args": ["/home/zdendys/mcp-servers/syncthing/dist/index.js"]
}
}
}Note: Environment variables are loaded from system, not hardcoded in config.
4. Restart Claude Desktop
The MCP tools will be available in your next Claude Code session.
Usage Examples
Check System Status
syncthing_get_status()List All Folders
syncthing_list_folders()Get Folder Status
syncthing_get_folder_status({ folder: "zoaz2-u7tor" })Check File Information
syncthing_get_file_info({
folder: "zoaz2-u7tor",
file: "minecraft/client-mods-1.21.1.zip"
})Trigger Folder Scan
syncthing_scan_folder({ folder: "zoaz2-u7tor" })
// Or scan specific subfolder:
syncthing_scan_folder({ folder: "zoaz2-u7tor", sub: "minecraft" })Check Connection Status
syncthing_get_connections()Troubleshooting
API Key Not Set
If you see: [ERROR] SYNCTHING_API_KEY environment variable is not set
Solution: Make sure environment variable is set in Claude Desktop config.
Connection Refused
If you see: Syncthing API error: connect ECONNREFUSED
Solution:
Verify Syncthing is running:
ps aux | grep syncthingCheck API URL is correct (default: http://localhost:8384)
Verify Syncthing web UI is accessible in browser
API Key Invalid
If you see: Syncthing API error: 403 Forbidden
Solution: Double-check your API key in Syncthing settings.
Development
Build
npm run buildWatch Mode
npm run watchTest Tools Manually
export SYNCTHING_API_KEY="your-key"
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | node dist/index.jsArchitecture
Language: TypeScript
MCP SDK: @modelcontextprotocol/sdk
API Client: Native fetch API
Transport: stdio (standard input/output)
Security Notes
API key is loaded from environment variables (never hardcoded)
All API communication happens locally (default: localhost:8384)
No external network requests
Read-only operations are safe; write operations (scan) require user approval in Claude Code
License
MIT
Authors
Zdendys (Project Manager)
Nyara (AI Assistant)
Available Tools
8 toolssyncthing_get_connectionsB
Get current connection status for all devices
Inputs: no named parameters.
syncthing_get_file_infoA
Get detailed information about a specific file including local and global versions
Inputs: file (required), folder (required).
syncthing_get_folder_errorsC
Get list of errors for a specific folder
Inputs: folder (required).
syncthing_get_folder_statusB
Get detailed status of a specific folder including sync state, errors, and byte counts
Inputs: folder (required).
syncthing_get_statusA
Get overall Syncthing system status including version, uptime, and system info
Inputs: no named parameters.
syncthing_list_devicesB
List all configured devices with their IDs and connection status
Inputs: no named parameters.
syncthing_list_foldersA
List all configured folders with their IDs, labels, and paths
Inputs: no named parameters.
syncthing_scan_folderB
Trigger a scan of a folder or subfolder to detect changes
Inputs: folder (required), sub.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 8 tools
Most tools have clearly distinct purposes: status, folder listing/status/errors, file info, scan, and device listing. However, syncthing_list_devices and syncthing_get_connections overlap in reporting device connection status, which could cause mild confusion about which to use.
All tools follow a consistent syncthing_<verb>_<noun> pattern (get_status, list_folders, get_folder_status, scan_folder, etc.). There are no mixed conventions or vague names.
Eight tools is well-scoped for a Syncthing monitoring and scan-control server. Each tool earns its place, and there is no excessive duplication or thin coverage.
The set covers read-only inspection and folder scanning well, but lacks any mutation or lifecycle operations such as adding/removing folders, adding/removing devices, pausing/resuming devices, or changing configuration. These are notable gaps for a server named mcp-server-syncthing.
Maintenance
Related MCP Connectors
Manage Cronitor monitors, issues, status pages, and metrics for jobs, uptime, and sites.
Pingstack monitors cron jobs and scheduled tasks with heartbeat checks, and checks websites, TCP ports, DNS records, SSL certificates and domain expiry. This MCP server lets your agent create, update, pause and delete checks, build dashboards and publish them as status pages, manage notification groups, and read incidents with their causes, uptime, run history and latency. Pause, delete and unpublish stay off until you turn them on. Browser sign-in, no API key needed.
Uptime monitoring: read monitors, incidents and response times; create and change monitors.
Uptime monitoring: monitors, incidents, status pages; create, pause and acknowledge.
1
Related MCP Servers
- AlicenseNot gradedqualityDmaintenanceA comprehensive MCP server providing 35 tools for monitoring and managing multiple Syncthing file synchronization instances. It enables users to track sync status, manage device connections, and modify folder configurations through natural language commands.2MIT
- AlicenseNot gradedqualityDmaintenanceEnables interaction with Home Assistant through the REST API, allowing users to query states, call services, and manage entities via natural language.76 PyPIMIT
- AlicenseNot gradedqualityBmaintenanceEnables inspection and management of Caddy reverse proxy configuration via CaddyUI's REST API, including proxy hosts, redirection hosts, raw routes, and TLS certificates.3MIT
- FlicenseNot gradedqualityCmaintenanceEnables MCP clients to inspect Synology NAS system, storage, and utilization, and manage Docker containers via the Synology Web API with automatic session handling.-