This directory documents how to configure and deploy openapi-mcp-sdk in different
runtime environments.
Each environment file specifies the required environment variables, storage backend, cache backend, and any platform-specific notes.
| Variable | Default | Description |
|---|---|---|
MCP_PORT |
8080 |
HTTP port the server listens on |
MCP_ENV |
production |
Runtime environment: dev | staging | production |
MCP_BASE_URL |
http://localhost:8080 |
Public URL of this server (used in callback URLs) |
MCP_CALLBACK_URL |
$MCP_BASE_URL/callbacks |
Full callback URL sent to async APIs |
MCP_OPENAPI_ENV |
(empty) | Openapi environment: dev, test, sandbox (alias of test), or empty for production |
MCP_STORAGE_BACKEND |
local |
Storage backend: local | gcs | s3 |
MCP_STORAGE_PATH |
./openapi_storage |
Local filesystem path for local backend |
MCP_STORAGE_BUCKET |
(required for cloud) | Bucket/container name for gcs or s3 backend |
MCP_STORAGE_REGION |
(required for s3) | AWS region for the S3 bucket |
MCP_CACHE_BACKEND |
none |
Cache for async callbacks: none | memcached | redis |
MCP_CACHE_HOST |
(none) | Memcached host (used when MCP_CACHE_BACKEND=memcached) |
MCP_CACHE_PORT |
11211 |
Memcached port |
MCP_CACHE_URL |
(none) | Redis connection URL (used when MCP_CACHE_BACKEND=redis) |
Several openapi.com APIs return large binary responses (documents, reports, archives)
that cannot be embedded inline in the MCP JSON-RPC stream. The server downloads these
files, stores them, and returns a download link (/status/{id}/files/{name}) that
the MCP client can fetch separately.
The visurecamerali tool (Italian company official documents) is the primary example:
it downloads ZIP archives from the openapi.com backend and serves individual files
to the MCP client.
Without a writable storage path the file-download APIs will fail. Make sure the
configured backend is accessible, writable, and — if using local — that the path
survives process restarts if persistence is needed.
| File | Platform |
|---|---|
local.md |
Local machine or CI (default) |
docker.md |
Docker / Docker Compose |
gcp.md |
Google Cloud Platform (Cloud Run + GCS + Memcached) |
aws.md |
Amazon Web Services (ECS/Fargate + S3 + ElastiCache) |
kubernetes.md |
Kubernetes (any cloud or on-prem) |