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/apipath.IMMICH_API_KEY: Your Immich API key.
Functional Testing
To run the functional tests, see the instructions in tests/functional/README.md.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file immich_mcp-0.5.7.tar.gz.
File metadata
- Download URL: immich_mcp-0.5.7.tar.gz
- Upload date:
- Size: 52.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d19be72af27efd36cd62d933d10a662f17dd83a2a39349170a49d1f776b62cf
|
|
| MD5 |
e2d0046382bbc0d936ed7994c1ba1edf
|
|
| BLAKE2b-256 |
963b887b5d0210bf5d3a679b8caf6992995f6029009cf4d1e4fc086c8c2fc98d
|
Provenance
The following attestation bundles were made for immich_mcp-0.5.7.tar.gz:
Publisher:
release.yml on zygou-31/immich-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
immich_mcp-0.5.7.tar.gz -
Subject digest:
5d19be72af27efd36cd62d933d10a662f17dd83a2a39349170a49d1f776b62cf - Sigstore transparency entry: 464158391
- Sigstore integration time:
-
Permalink:
zygou-31/immich-mcp@54a57620592f1e4180a8325411432d420cd9fe31 -
Branch / Tag:
refs/tags/v0.5.7 - Owner: https://github.com/zygou-31
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@54a57620592f1e4180a8325411432d420cd9fe31 -
Trigger Event:
push
-
Statement type:
File details
Details for the file immich_mcp-0.5.7-py3-none-any.whl.
File metadata
- Download URL: immich_mcp-0.5.7-py3-none-any.whl
- Upload date:
- Size: 5.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6650b2fa71228539b73219030ffd13e9c263c953f47f29b29d5583f8db81d9ef
|
|
| MD5 |
86a852e7463a2e5e59b36effe66c376e
|
|
| BLAKE2b-256 |
5aaa6dd0a864bbe679f4a1657b564fe3b98371413803ed8d113fd5c68d1b5491
|
Provenance
The following attestation bundles were made for immich_mcp-0.5.7-py3-none-any.whl:
Publisher:
release.yml on zygou-31/immich-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
immich_mcp-0.5.7-py3-none-any.whl -
Subject digest:
6650b2fa71228539b73219030ffd13e9c263c953f47f29b29d5583f8db81d9ef - Sigstore transparency entry: 464158480
- Sigstore integration time:
-
Permalink:
zygou-31/immich-mcp@54a57620592f1e4180a8325411432d420cd9fe31 -
Branch / Tag:
refs/tags/v0.5.7 - Owner: https://github.com/zygou-31
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@54a57620592f1e4180a8325411432d420cd9fe31 -
Trigger Event:
push
-
Statement type:
