.env.exampleβ’1.86 kB
# Outline MCP Server - Environment Configuration
# Copy this file as .env and fill in the required values
# =============================================================================
# REQUIRED VARIABLES
# =============================================================================
# API key for Outline (required)
# Get it from: https://your-outline.com/settings/tokens
OUTLINE_API_KEY=outline_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# =============================================================================
# OPTIONAL VARIABLES
# =============================================================================
# Outline API URL (default: https://app.getoutline.com/api)
# Specify if using self-hosted Outline
OUTLINE_API_URL=https://your-outline.com/api
# Log level (default: info)
# Possible values: error, warn, info, debug, trace
RUST_LOG=info
# HTTP server address (default: 127.0.0.1)
# Used only in --http mode
HTTP_HOST=127.0.0.1
# HTTP server port (default: 3000)
# Used only in --http mode
HTTP_PORT=3000
# =============================================================================
# USAGE EXAMPLES
# =============================================================================
# 1. STDIO mode (main for MCP):
# OUTLINE_API_KEY=xxx ./outline-mcp --stdio
#
# 2. HTTP mode (for debugging):
# OUTLINE_API_KEY=xxx ./outline-mcp --http
#
# 3. With custom API URL:
# OUTLINE_API_KEY=xxx OUTLINE_API_URL=https://my-outline.com/api ./outline-mcp-rs --stdio
#
# 4. With debug logging:
# OUTLINE_API_KEY=xxx RUST_LOG=debug ./outline-mcp --stdio
# =============================================================================
# SECURITY
# =============================================================================
# IMPORTANT: Never commit real API key to git!
# Add .env to .gitignore
# Use only for local development