Skip to main content
Glama
mcp-server-syncthing

mcp-server-syncthing

by Zdendys79

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 paths

  • syncthing_get_folder_status - Get detailed folder status (sync state, errors, byte counts)

  • syncthing_get_folder_errors - Get list of errors for a specific folder

  • syncthing_get_file_info - Get file information (local vs global versions)

  • syncthing_list_devices - List all configured devices

  • syncthing_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 build

2. 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:

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 syncthing

  • Check 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 build

Watch Mode

npm run watch

Test Tools Manually

export SYNCTHING_API_KEY="your-key"
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list"}' | node dist/index.js

Architecture

  • 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 tools
syncthing_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

    A3.5/5.0

    Scored across 8 tools

    Disambiguation4/5

    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.

    Naming Consistency5/5

    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.

    Tool Count5/5

    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.

    Completeness3/5

    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

    ActivityInactive
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      A 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.
      2
      MIT
    • F
      license
      Not graded
      quality
      C
      maintenance
      Enables MCP clients to inspect Synology NAS system, storage, and utilization, and manage Docker containers via the Synology Web API with automatic session handling.
      -