Skip to content

Installation

PyPI

pip install objectstore-mcp            # core: local filesystem backend only
pip install objectstore-mcp[s3]        # + boto3 (AWS S3, MinIO, Cloudflare R2)
pip install objectstore-mcp[gcs]       # + google-cloud-storage
pip install objectstore-mcp[azure]     # + azure-storage-blob
pip install objectstore-mcp[all]       # every cloud backend

The core install carries zero cloud dependencies: only the filesystem backend is importable, and building a cloud backend without its SDK raises a MissingDependencyError that names the extra to install.

Credentials

Backend Resolution
S3-compatible Store credentials: access_key_id, secret_access_key (secret references). Per-store endpoint; presign_endpoint for externally reachable signed URLs.
GCS Store credentials.service_account_json (secret reference), else the platform workload identity.
Azure Blob Store credentials.connection_string (secret reference).
WebDAV Store credentials: username, password (secret references); endpoint is the collection root.
Filesystem None. Root directory from the store's root or OBJECTSTORE_FS_ROOT.

Docker

docker compose -f docker/compose.yml up --build     # build from source
docker compose -f docker/mcp.compose.yml up         # published image

Both run the server on streamable-http at port 8000 with the local store persisted in the objectstore-data volume.

Development install

pip install -e .[test]       # core + pytest stack (no cloud SDKs needed)
pip install -e .[test-s3]    # adds boto3 + moto for S3 integration tests
pytest
pre-commit run --all-files