Skip to main content

​
Prerequisites

RequirementVersionPurpose
Docker24+Container runtime
Docker Composev2+Multi-container orchestration

​
Quick Start

1

Create a project directory

mkdir smkrv-mcp-studio && cd smkrv-mcp-studio
2

Download docker-compose.yml

Download the production docker-compose.yml from the release page (location TBD) and place it in the project directory.
3

Create .env file

Create a .env file with the required security variables:
STUDIO_ENCRYPTION_KEY=<generate: python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())">
STUDIO_JWT_SECRET=<generate: openssl rand -hex 32>
REDIS_PASSWORD=<generate: openssl rand -base64 32>
STUDIO_AGENT_SERVICE_TOKEN=<generate: openssl rand -hex 32>
See Configuration Reference for all available variables and how to generate secret values.
4

Start the application

docker compose up -d

# Verify
curl http://localhost:3000/api/health
# Expected: {"status":"ok","version":"..."}
The UI is available at http://localhost:3000.

​
First-Run Setup

On first visit, the app detects that no admin account exists and shows the Setup screen:
  1. Create Admin Account — enter a username and password (minimum 8 characters). This is the only admin account for the installation.
  2. Login — after setup, you are automatically logged in and redirected to the Dashboard.
  3. (Optional) Enable 2FA — go to Settings, open the 2FA section, and scan the QR code with an authenticator app (Google Authenticator, Authy, 1Password, etc.). Save your recovery codes.

​
First Steps

1

Create a Connection

Go to the Connections page, click New Connection, select your database type, enter credentials, and test the connection.
2

Build a Tool

Go to the Tools page, click New Tool, select your connection, write a SQL query with parameters (e.g., SELECT * FROM users WHERE id = :user_id), and save.
3

Build Resources and Prompts

Optionally create Resources (data endpoints) and Prompts (template messages) in the same way.
4

Deploy

Go to the Server page and click Deploy. See Deployment for details and MCP client configuration.
5

Connect a Client

Go to Server > Connect tab to get the MCP endpoint URL and configuration snippets for Claude Desktop, Cursor, or Claude Code.

​
Verify Installation

Open http://localhost:3000 in your browser — you should see the Setup screen (first run) or the Login page. You can also verify via the terminal: 
curl http://localhost:3000/api/health
# Expected: {"status":"ok","version":"..."}
After deploying your first MCP server, check its status on the Server page — the status badge shows Running when the server is active.

​
Next Steps