Skip to content

immich-api

Immich Api API + MCP Server using the connector SDK — a typed, action-routed connector.

Official documentation

This site is the canonical reference for immich-api, maintained alongside every release.

PyPI MCP Server License GitHub

Overview

immich-api wraps the target service with typed, deterministic MCP tools.

Tools resolve IMMICH_API_BASE_URL, IMMICH_API_TOKEN_REF, and the SDK TLS profile when invoked. Discovery requires no vendor credentials or live service.

Explore the documentation

  • :material-rocket-launch: Installation — pip, source, extras, and the prebuilt Docker image.
  • :material-server-network: Deployment — run local transports or connect through an authenticated TLS ingress.
  • :material-console: Usage — the MCP tools, the Python client, and the CLI.
  • :material-database-cog: Backing Platform — deploy the target service with Docker.
  • :material-sitemap: Overview — the action-routed tool surface and architecture.
  • :material-graph: Concepts — the CONCEPT ID registry.