Model Context Protocol Server for Apache OpenDAL™

1# Model Context Protocol Server for Apache OpenDAL™
2A Model Context Protocol (MCP) server implementation that provides access to various storage services via [Apache OpenDAL™](https://opendal.apache.org/).
3 
4[![PyPI - Version](https://img.shields.io/pypi/v/mcp-server-opendal)](https://pypi.org/project/mcp-server-opendal/)
5[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mcp-server-opendal)](https://pypi.org/project/mcp-server-opendal/)
6[![Lint and Test](https://github.com/Xuanwo/mcp-server-opendal/actions/workflows/test.yml/badge.svg)](https://github.com/Xuanwo/mcp-server-opendal/actions/workflows/test.yml)
7 
8## Features
9 
10- Seamless access to multiple storage services including S3, Azure Blob Storage, Google Cloud Storage, and more
11- List files and directories from storage services
12- Read file contents with automatic text/binary detection
13- Environment variable based configuration
14 
15## Installation
16 
17```shell
18pip install mcp-server-opendal
19```
20 
21## Usage with Claude Desktop
22 
23Add the following to `claude_desktop_config.json`:
24 
25```json
26{
27  "mcpServers": {
28    "opendal": {
29      "command": "uvx",
30      "args": [
31        "mcp-server-opendal"
32      ],
33      "env": {
34        "YOUR_ENV_VAR": "YOUR_ENV_VALUE"
35      }
36    }
37  }
38}
39```
40 
41It requires `uv` to be installed on your machine. Check the [official documentation](https://docs.astral.sh/uv/getting-started/installation/) for installation guides.
42 
43## Environment variables
44 
45Configure storage services by setting environment variables. Each service requires a prefix and specific configuration options.
46 
47For example, to configure an S3 service with alias "mys3":
48 
49```
50OPENDAL_MYS3_TYPE=s3
51OPENDAL_MYS3_BUCKET=mybucket
52OPENDAL_MYS3_REGION=us-east-1
53OPENDAL_MYS3_ENDPOINT=http://localhost:9000
54OPENDAL_MYS3_ACCESS_KEY_ID=myaccesskey
55OPENDAL_MYS3_SECRET_ACCESS_KEY=mysecretkey
56```
57 
58Then you can use tool like `read` and `list` with `mys3://path/to/file`.
59 
60`mcp-server-opendal` will also load from `.env`.
61 
62## Development
63 
64```shell
65npx @modelcontextprotocol/inspector \
66  uv run mcp-server-opendal
67```
68