Skip to main content

tai42-storage-local

CI License: Apache 2.0

Local-filesystem storage backend for the TAI ecosystem. It implements the tai42_contract.storage.Storage contract over a directory tree on the local disk, serving both text and binary content, and registers itself as the active storage provider when its package is imported.

The TAI ecosystem

TAI is an open-source runtime for MCP tools, agents, and workflows. A Storage backend answers the question of where content physically lives — a template, a document, or a media file loaded by id. This package is the local-filesystem implementation; siblings back the same contract with S3 (tai42-storage-s3) and GitHub (tai42-storage-github). The ecosystem is open-ended: any package can back the same contract, so this repo is this provider's own full doc home, and the documentation site covers the platform-level story:

Install

Requires Python 3.13+. Install from PyPI into the environment that runs the server:

uv add tai42-storage-local

Or from source — clone this repo and add it as an editable dependency. Clone tai-contract and tai-kit beside this repo first — [tool.uv.sources] resolves them from sibling paths.

git clone https://github.com/tai42ai/tai-storage-local   # next to your app checkout
cd /path/to/your/app
uv add --editable ../tai-storage-local

Discovery

A backend is activated by a manifest, not an entry point. Name this package in the manifest's storage_module field; the runtime imports it, and the @tai42_app.storage.register_storage decorator fires as an import side-effect to register LocalStorage as the active provider:

storage_module: tai42_storage_local

There is no auto-discovery — importing the package is the registration.

Configuration

Settings are read from the environment (or a .env file) with the STORAGE_LOCAL_ prefix:

Variable Default Description
STORAGE_LOCAL_ROOT_PATH ./templates The base directory every stored path is resolved under.
STORAGE_LOCAL_CREATE_DIRS true Create missing parent directories on write.

Contract surface

LocalStorage implements the full eight-method Storage contract:

  • Text: load (raises FileNotFoundError when missing), list, upload, delete, delete_dir.
  • Binary/media: load_bytes / upload_bytes read and write raw bytes directly (no encoding); stat inherits the contract's mimetypes-based path inference, since the local filesystem stores no content-type metadata.

Every path is resolved under the configured root and rejected if it escapes it (a path-boundary check, not a string prefix), and delete_dir refuses the storage root via the shared assert_not_root guard.

Development

uv venv --python 3.13
uv pip install --no-sources --group dev --editable .
uv run --no-sync pytest --cov --cov-report=term-missing
uv run --no-sync ruff check .
uv run --no-sync ruff format --check .
uv run --no-sync pyright

License

Apache-2.0. See LICENSE and NOTICE.

Download files

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

Source Distribution

tai42_storage_local-0.2.0.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

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

tai42_storage_local-0.2.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file tai42_storage_local-0.2.0.tar.gz.

File metadata

  • Download URL: tai42_storage_local-0.2.0.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for tai42_storage_local-0.2.0.tar.gz
Algorithm Hash digest
SHA256 772a2fe8077703aa3b5e2e531cbedd3c25e661184d59f167aeaf383e773c8312
MD5 ba2a22b84311518b57c9c4a6fe617caa
BLAKE2b-256 e1b99314cab78333d17eb28886162441b8fbade19b400c583caa6b02910a8631

See more details on using hashes here.

File details

Details for the file tai42_storage_local-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tai42_storage_local-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b65a0538d367725902bd0da99fae719c68d74483937e39ea466cf75872127e2
MD5 0b5a3767b97923cb7a2ce9fbe2aa54c9
BLAKE2b-256 3e986d232390d3757f4dce5e6e5d3319bc2631ad229df01a5f2895d889e43b71

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 Sentry Error logging StatusPage Status page