What is immich-mcp AGENTS.md?

Contributor instructions for Immich MCP, a project that connects agents to Immich, a self-hosted photo and video library.

Use them when installing dependencies, running the development server, building, testing, linting, or organizing JavaScript, TypeScript, and Python files in the repository.

They document the source layout, development commands, naming rules, and testing expectations so contributors can change the project consistently.

How zygou-31/immich-mcp configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to zygou-31/immich-mcp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/zygou-31/immich-mcp/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/zygou-31/immich-mcp

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/zygou-31/immich-mcp/agents-md/github.svg)](https://agentmods.dev/instructions/zygou-31/immich-mcp/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/zygou-31/immich-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/zygou-31/immich-mcp/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/zygou-31/immich-mcp/agents-md"><img src="https://agentmods.dev/badge/instructions/zygou-31/immich-mcp/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 897 This file is loaded in full into every session.

When invoked 897 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00897	$0.00897
Opus 5	$0.00449	$0.00449
Sonnet 5	$0.00179	$0.00179
Haiku 4.5	$0.00090	$0.00090

Measured 9d ago against content hash 291f10ae52c8, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

immich-mcp AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 70 lines

How it starts

The opening of the file, as written. The whole thing — 70 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

This document is a concise contributor guide for this repository. Follow the examples and commands below when working locally.

Project Structure & Module Organization

src/: primary source code. Example: src/services, src/controllers.
tests/: unit and integration tests (*.spec.* or *_test.*).
assets/: static files, images, and fixtures.
docker/ or deploy/: container and deployment manifests.
scripts/: helper scripts and tooling.

Build, Test, and Development Commands

Install deps: npm install or yarn — installs project dependencies.
Dev server: npm run dev — starts local development server with hot reload.
Build: npm run build or make build — compiles production artifacts.
Test: npm test or make test — runs unit and integration tests.
Docker: docker-compose up --build — containerized local environment.

Coding Style & Naming Conventions

Indentation: 2 spaces for JS/TS, 4 spaces for Python.
Files: kebab-case for filenames (e.g., user-service.ts).
Variables/Functions: camelCase; Classes/Components: PascalCase.
Formatting/Linting: use prettier and eslint where configured. Example: npm run lint and npm run format.

Testing Guidelines

Frameworks: project uses standard test runners (Jest, Mocha, or Pytest depending on language).
Naming: unit tests *.spec.* or *_test.*; integration under tests/integration/.
Coverage: aim for meaningful coverage around core logic; run npm test -- --coverage.
Functional tests: Tests that require a running Immich instance (real-world integration) are documented in tests/functional/README.md. An optional, manually-triggered CI workflow is provided at .github/workflows/functional-tests.yml for running these tests in an environment where an Immich instance and credentials are available.
Functional tests workflow usage & safety: The workflow is intended for manual triggering only. Provide immich_url and immich_key at dispatch or store them as repository secrets named IMMICH_BASE_URL and IMMICH_API_KEY. Do not store credentials in the repository. Avoid running the workflow against production servers and be aware that uploaded logs may contain sensitive information; restrict access to workflow artifacts as appropriate.

Read the full file on GitHub · 70 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

9d ago First seen · 70 lines · 897 tokens per session scan A 291f10ae52c8

Subscribe to this mod's changes

immich-mcp AGENTS.md is an instructions file published in the GitHub repository zygou-31/immich-mcp (1 stars, last pushed 1y ago), licensed MIT. It adds 897 tokens to every session, about $0.0045 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

immich-mcp: Instructions file for Codex