Skip to main content

An MCP server for Immich.

Project description

Immich MCP Server

This project provides a Model Context Protocol (MCP) server for the Immich photo management system.

Installation

It is recommended to use a virtual environment.

pip install .

For development, you can install the project with its development dependencies:

pip install -e ".[dev]"

Running the Server

To run the server for development, you can use the mcp command-line tool provided by the mcp package. As recommended by the MCP Python SDK Quickstart, uv is the preferred tool for running the server.

First, ensure uv is installed:

pip install uv

Then, run the server:

uv run mcp dev src/immich_mcp/server.py

Configuration

The server requires the following environment variables to be set to connect to your Immich instance:

  • IMMICH_BASE_URL: The base URL of your Immich instance (e.g., http://immich.local:2283). The server will automatically append the required /api path.
  • IMMICH_API_KEY: Your Immich API key.

Functional Testing

To run the functional tests, see the instructions in tests/functional/README.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

immich_mcp-0.5.6.tar.gz (52.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

immich_mcp-0.5.6-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file immich_mcp-0.5.6.tar.gz.

File metadata

  • Download URL: immich_mcp-0.5.6.tar.gz
  • Upload date:
  • Size: 52.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for immich_mcp-0.5.6.tar.gz
Algorithm Hash digest
SHA256 33e7536aaab6204c6280f9ef688a7d0779968cf9a5530d8eaf385e9e50d377df
MD5 59e23dba9485d0c53de38759995b66fd
BLAKE2b-256 9e1e6e6193f91c184daa03443cb78cea8fc966cd76cd43e4d5846d2ecb1b1f4e

See more details on using hashes here.

File details

Details for the file immich_mcp-0.5.6-py3-none-any.whl.

File metadata

  • Download URL: immich_mcp-0.5.6-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for immich_mcp-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 7b90b130496161b48d76fe1ab8f3a728e02527b54e596e6b9ab56c267773357d
MD5 161a64f0cca6d51cca2071232264e666
BLAKE2b-256 07bc48c35e8310ab94fa35e145a8b380783ac877de7609ac18738b957e227bb4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page