Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
APP_NAME | No | Name of the MCP Plexus application. | MCP Plexus Server |
REDIS_DB | No | Redis database index. | 0 |
REDIS_SSL | No | Whether to use SSL for Redis connections (optional). | |
DEBUG_MODE | No | Set to 'True' for development (more verbose logging, Uvicorn reload). | True |
REDIS_HOST | Yes | Redis server hostname or IP address. Required for MCP sessions. | localhost |
REDIS_PORT | No | Redis server port. | 6379 |
ADMIN_API_KEY | Yes | A secret API key for accessing administrative endpoints (e.g., managing tenants, external OAuth providers). | |
REDIS_PASSWORD | No | Redis server password (optional). | |
SQLITE_DB_PATH | No | Path to the SQLite database file. | ./mcp_plexus_data.sqlite3 |
DEV_SERVER_HOST | No | Host for the Uvicorn development server. | 127.0.0.1 |
DEV_SERVER_PORT | No | Port for the Uvicorn development server. | 8000 |
STORAGE_BACKEND | No | Set to 'sqlite' (default) or 'redis' for most persistent stores (e.g., Plexus user auth tokens, external OAuth provider configs). | sqlite |
DEV_SERVER_RELOAD | No | Whether to enable auto-reload for the Uvicorn development server. | True |
DEV_SERVER_LOG_LEVEL | No | Log level for the Uvicorn development server. | info |
PLEXUS_ENCRYPTION_KEY | Yes | A Fernet encryption key used for encrypting sensitive data like API keys and external OAuth tokens stored in the database. | |
PLEXUS_CLI_API_BASE_URL | No | Base URL for the Plexus CLI API. | http://127.0.0.1:8080 |
PLEXUS_FASTMCP_LOG_LEVEL | No | Logging level for the FastMCP component (e.g., 'DEBUG', 'INFO'). | DEBUG |
HOST_APP_REGISTRATION_SECRET | Yes | A strong, unique secret that host applications must provide to register their users with Plexus (via the X-Host-App-Secret header). |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
No prompts |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
No resources |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
No tools |