Skip to main content
Glama

Logitech Sync MCP

English | Français

CI Python 3.12+ License: MIT

A read-only Model Context Protocol server for the Logitech Sync Cloud API. It turns the API's place inventory endpoint into nine focused tools that AI clients can use to inspect rooms, desks, devices, health, occupancy, coverage, environmental readings, and network information.

The server is written in Python, managed with UV, and connects to Logitech Sync with mutual TLS (mTLS). Certificate material stays on the local machine and is never accepted as a tool argument or returned in a tool response.

This is an independent integration and is not affiliated with or endorsed by Logitech. See Notices.

IMPORTANT

This integration is strictly read-only. Logitech Sync Cloud API 0.1.4 exposes the inventory operationGET /org/{orgId}/place; this project does not provide write, update, or delete operations. Authorized administrators can obtain the vendor API documentation from Sync Portal.

Tools

Tool

Purpose

logitech_sync_check_connection

Validate the configuration, mTLS connection, license, and organisation access with a minimal request.

logitech_sync_list_places

Read a native page of rooms or desks with explicit projection and cursor controls.

logitech_sync_search_inventory

Search places and devices by name, ID, serial number, version, contract, IP address, MAC address, or hostname.

logitech_sync_get_inventory_summary

Summarise places, coverage, device types, models, versions, statuses, and health.

logitech_sync_list_device_issues

Find offline, warning, error, stale, or incomplete devices.

logitech_sync_get_occupancy_report

Report occupancy, known capacity, utilisation, and over-capacity places.

logitech_sync_get_environment_report

Read and filter available Spot and Rally Board sensor measurements without inventing health thresholds.

logitech_sync_get_coverage_report

Audit contracts, licences, and warranties as of a given date.

logitech_sync_list_network_inventory

Inventory IP addresses, MAC addresses, hostnames, and wired or Wi-Fi interfaces.

All tools declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=true.

Related MCP server: abm-mcp

Requirements

  • UV

  • A Logitech Sync organisation ID from Sync Portal → Settings → Sync Cloud API

  • A PEM client certificate and its matching private key

  • A compatible Logitech Select, Essential, or Sync Plus license

Quick start

git clone https://github.com/bouchecousue/logitech-sync-mcp.git
cd logitech-sync-mcp
cp .env.example .env

Place your credentials at the default paths:

client-certificate/certificate.pem
client-certificate/privateKey.pem

Set LOGITECH_SYNC_ORG_ID in .env, restrict the private key, then install and start the server:

chmod 600 client-certificate/privateKey.pem
uv sync --all-groups --no-editable
uv run --no-editable python run_server.py

The last command starts a stdio MCP server and waits for protocol messages on standard input. See the complete Getting Started guide for certificate setup, client configuration, validation, and troubleshooting.

MCP client configuration

Generic stdio configuration:

{
  "mcpServers": {
    "logitech-sync": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/logitech-sync-mcp",
        "run",
        "--no-editable",
        "python",
        "/path/to/logitech-sync-mcp/run_server.py"
      ]
    }
  }
}

The server loads .env from the project directory. Keep credentials out of the MCP client configuration when possible so they are not duplicated across configuration files.

Configuration

Variable

Default

Description

LOGITECH_SYNC_ORG_ID

none

Required organisation ID from Logitech Sync Portal.

LOGITECH_SYNC_API_BASE_URL

https://api.sync.logitech.com/v1

Documented API server; override only for administration or testing.

LOGITECH_SYNC_CERT_FILE

client-certificate/certificate.pem

Client certificate path; an absolute path is recommended.

LOGITECH_SYNC_KEY_FILE

client-certificate/privateKey.pem

Private key path; an absolute path is recommended.

LOGITECH_SYNC_CA_FILE

public CA bundle

Optional custom CA bundle.

LOGITECH_SYNC_TIMEOUT_SECONDS

30

Overall timeout for one attempt.

LOGITECH_SYNC_CACHE_TTL_SECONDS

60

Short in-memory cache to reduce quota usage.

LOGITECH_SYNC_MAX_RETRIES

3

Bounded retries for 429/502/503/504 and transport errors.

LOGITECH_SYNC_MIN_REQUEST_INTERVAL_SECONDS

1

Minimum interval between network attempts.

LOGITECH_SYNC_TRUST_ENV

false

Explicitly allow HTTPX environment proxies and CA settings.

LOGITECH_SYNC_FIXTURE_FILE

none

Offline fixture mode for tests and evaluations.

The organisation ID is a separate value: the server never attempts to infer it from the X.509 certificate subject.

Pagination, quotas, and output

According to the supplied Logitech documentation, the API allows 14,400 requests per day, supports a sustained rate of one request per second, and recommends exponential backoff. The client therefore:

  • serialises network attempts at a minimum one-second interval;

  • honours Retry-After without retrying early;

  • applies bounded exponential backoff with jitter;

  • caches pages briefly and caps the cache at 256 pages;

  • detects cursor loops;

  • bounds workflows with page_size, max_pages, and max_results;

  • exposes nextResultOffset when an aggregated result has another local page;

  • keeps text and structuredContent within a combined MCP response budget and reports truncation explicitly.

Tools support markdown and json text rendering and return schema-validated structuredContent. An omitted projection preserves Logitech's default projection, while [] requests place IDs only. Device child projections automatically include their required parent projection.

Security model

  • .env, client-certificate/, private-key formats, caches, and local tooling files are excluded from Git.

  • On POSIX systems, startup fails if the private key is readable by the group or other users.

  • Server certificate verification remains enabled; the implementation has no verify=False path.

  • HTTP redirects are disabled so the client certificate is not presented to another host.

  • PEM data is never exposed through MCP arguments or results.

  • Application logs never use stdout, which is reserved for the stdio protocol.

  • API-provided strings are treated as untrusted data and escaped in Markdown output.

  • The API URL and secret paths are administrator configuration, not model-controlled tool inputs.

Before publishing a fork or opening a pull request, run:

git status --short
git check-ignore -v .env client-certificate/privateKey.pem

Never commit an organisation ID, certificate, private key, captured API response, or real inventory fixture.

Development

uv sync --all-groups --no-editable
uv run --no-editable ruff check .
uv run --no-editable ruff format --check .
PYTHONPATH=src uv run --no-sync pytest --cov=logitech_sync_mcp
uv run --no-editable python -m compileall -q src

The live test consumes API quota and is disabled by default:

LOGITECH_SYNC_RUN_LIVE=1 uv run --no-editable pytest -m live tests/test_live.py

The deterministic evaluation set uses the versioned synthetic fixture, never a live inventory.

Documentation

License

Released under the MIT License.

Available Tools

9 tools
logitech_sync_check_connectionCheck Logitech Sync connectionA
Read-onlyIdempotent

Verify live mTLS access, or validate the configured offline fixture.

    Makes exactly one minimal GET request with ``limit=1`` and an empty projection, so only
    a place id can be returned. In fixture mode no network connection or mTLS handshake is
    attempted, and the result says so explicitly. It does not modify Logitech Sync. Use this
    first after setup.

    Returns a structured success envelope plus Markdown/JSON text. Configuration, TLS, 403,
    throttling, and schema failures are returned as actionable MCP tool errors.
    

Inputs: response_format. Returns: Structured output envelope shared by all Logitech Sync tools.

logitech_sync_get_coverage_reportGet Logitech Sync coverage reportA
Read-onlyIdempotent

Audit room/desk contracts, licenses, and device warranties at a given date.

    Rows are classified as expired, expiring, active, or unknown expiration. Supply ``as_of``
    for reproducible historical/evaluation queries; otherwise today's UTC date is used. Raw
    epoch timestamps and ISO forms are both retained.

    Returns status counts and chronologically sorted coverage rows. No renewal action occurs.
    

Inputs: as_of, desks, rooms, max_pages, +7 more. Returns: Structured output envelope shared by all Logitech Sync tools.

logitech_sync_get_environment_reportGet Logitech Sync environment reportA
Read-onlyIdempotent

Aggregate Spot/Rally Board sensor readings with explicit numeric filters.

    Supported measurements include CO2, pressure, temperature, humidity, TVOC, VOC index,
    PM10, PM2.5, and presence. The workflow never invents safety thresholds or labels readings
    dangerous; filtering only occurs when ``metric`` and caller-provided bounds are supplied.

    Returns device readings, UTC sample timestamps, per-metric min/max/average, and scan status.
    

Inputs: desks, rooms, metric, maximum, +7 more. Returns: Structured output envelope shared by all Logitech Sync tools.

logitech_sync_get_inventory_summarySummarize Logitech Sync inventoryA
Read-onlyIdempotent

Aggregate rooms, desks, coverage, device types/models/versions, status, and health.

Use this before deeper reports to understand inventory shape without returning every raw device. Pagination is bounded and all counts clearly indicate whether the scan completed.

Returns counters and ranked model/version buckets. It is read-only and uses a projection optimized for identity, coverage, and health aggregation.

Inputs: desks, rooms, max_pages, page_size, +3 more. Returns: Structured output envelope shared by all Logitech Sync tools.

logitech_sync_get_occupancy_reportGet Logitech Sync occupancy reportA
Read-onlyIdempotent

Report live room occupancy, known capacity, utilization, and over-capacity state.

    Logitech documents ``seatCount=0`` as unset, so this workflow marks capacity unknown and
    never divides by zero or labels such rooms over capacity. Results are sorted by current
    occupancy and can be filtered with caller-supplied thresholds.

    Returns bounded room rows and aggregate occupancy/capacity metrics. Live values may change.
    

Inputs: max_pages, page_size, unlicensed, max_results, +5 more. Returns: Structured output envelope shared by all Logitech Sync tools.

logitech_sync_list_device_issuesList Logitech Sync device issuesA
Read-onlyIdempotent

Diagnose offline, unhealthy, stale, or incomplete-peripheral devices.

    Each returned device includes explicit reason codes and its containing room/desk. A stale
    cutoff is only applied to Offline devices when the caller provides
    ``last_disconnection_before`` because Logitech defines ``lastSeen`` as the last
    disconnection event, not a heartbeat. Timestamps remain UTC and retain raw epoch values.

    Returns issue counts, reason counts, bounded issue details, and scan-completeness metadata.
    

Inputs: desks, rooms, max_pages, page_size, +9 more. Returns: Structured output envelope shared by all Logitech Sync tools.

logitech_sync_list_network_inventoryList Logitech Sync network inventoryA
Read-onlyIdempotent

Inventory reported device IPs, MACs, hostnames, and network interfaces.

Search by network identifier, place, or device, and optionally filter by interface mode. Missing network fields remain absent rather than being invented because reporting varies by device model and firmware. This tool does not scan the network or change configuration.

Returns bounded entries, interface-mode counts, and scan-completeness metadata.

Inputs: desks, query, rooms, max_pages, +6 more. Returns: Structured output envelope shared by all Logitech Sync tools.

logitech_sync_list_placesList Logitech Sync placesA
Read-onlyIdempotent

Fetch one controlled page of rooms/desks using the native continuation cursor.

    Use this primitive when exact API pagination or custom projections matter. It never follows
    the cursor automatically. If an explicit projection requests device info, sensors, or
    warranty while ``detail_level=concise``, the result is transparently promoted to detailed
    output and reports that adjustment. A response that is too large fails with guidance
    instead of silently discarding requested fields or inaccessible items.

    Returns ``places`` and metadata including ``next_continuation`` and the effective
    projection. Errors explain how to fix invalid scopes, projections, credentials, or quotas.
    

Inputs: desks, limit, rooms, projection, +4 more. Returns: Structured output envelope shared by all Logitech Sync tools.

logitech_sync_search_inventorySearch Logitech Sync inventoryA
Read-onlyIdempotent

Search across place and device inventory as one agent-oriented workflow.

    This tool follows bounded pagination and dynamically requests identity, location, contract,
    network, version, and health fields needed for useful matches. Use an exact id/serial for a
    specific entity or partial text for discovery. It does not modify inventory.

    Returns matching place/device objects plus complete/partial pagination metadata. Increase
    ``max_pages`` only when ``next_continuation`` shows the API scan was partial. When
    ``nextResultOffset`` is returned, repeat the same filters with that ``result_offset``.
    

Inputs: query (required), desks, rooms, target, +11 more. Returns: Structured output envelope shared by all Logitech Sync tools.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4.3/5.0

    Scored across 9 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose: connection check, coverage reports, environment sensors, inventory summary, occupancy, device issues, network inventory, places listing, and search. No overlap or ambiguity.

    Naming Consistency5/5

    All tools follow a consistent pattern: 'logitech_sync_' + verb_noun (e.g., check_connection, get_coverage_report, list_device_issues). Underscores are used uniformly, and verbs are appropriate for the action.

    Tool Count5/5

    9 tools is well-scoped for a monitoring/diagnostics server covering connection, reporting, inventory, issues, and search. Not excessive and each tool serves a specific need.

    Completeness4/5

    The tool set covers the main monitoring and diagnostic operations comprehensively: connection, coverage, environment, occupancy, issues, inventory, and search. Missing write/update operations, but the domain appears read-only, so minor gap.

    Maintenance

    ActivityInactive
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      C
      maintenance
      MCP server for the air-Q Cloud API, enabling remote retrieval of air quality sensor data and historical analysis through read-only tools like listing devices, fetching readings, and exporting charts or data.
      46 PyPI
      Apache 2.0
    • A
      license
      Not graded
      quality
      D
      maintenance
      A read-only MCP server that provides tools to list and read devices, MDM servers, blueprints, configurations, apps, packages, users, and other resources from Apple Business Manager and Apple School Manager.
      MIT
    • A
      license
      B
      quality
      D
      maintenance
      Read-only MCP server for Snipe-IT v7 REST API, providing search and retrieval of assets, users, models, categories, and locations without modification.
      16
      MIT