mysql-mcp/server-config-example.yaml at main · neverinfamous/mysql-mcp · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Value Proposition: Centralized, type-safe configuration for enterprise MySQL MCP deployment.
#
# MySQL MCP Server Configuration Example
# Load this configuration by running: mysql-mcp --config path/to/server-config-example.yaml
#
# Configuration Priority: CLI Flags > Environment Variables > Config File > Defaults
# For database connections and OAuth settings, the entire array/object must come from a single source
# to prevent mixing environments (e.g. CLI databases will fully override FILE databases).

# Server Core Settings
host: "127.0.0.1"
port: 3000
transport: "stdio" # or "http", "sse"
enableHSTS: false
trustProxy: false

# Tooling and Sandbox
toolFilter: "starter"
allowedIoRoots:
  - "C:/temp/mcp-sandbox"
  - "/tmp/mcp-sandbox"

# Audit Logging Configuration
auditConfig:
  enabled: true
  logPath: "/var/log/mysql-mcp/audit.jsonl"
  redact: true
  auditReads: false
  maxSizeBytes: 10485760 # 10MB
  backup:
    enabled: true
    includeData: false
    maxDataSizeBytes: 1048576 # 1MB

# Databases Configuration
# Only the first database in the array is currently connected/supported by the MySQL adapter.
databases:
  - type: "mysql"
    host: "localhost"
    port: 3306
    username: "mcp_user"
    password: "secure_password"
    database: "testdb"
    pool:
      connectionLimit: 10
      acquireTimeout: 10000
      waitForConnections: true
      queueLimit: 0

# OAuth 2.0 Resource Server Settings (Optional)
oauth:
  enabled: false
  issuer: "https://auth.example.com"
  audience: "mysql-mcp"
  jwksUri: "https://auth.example.com/.well-known/jwks.json"
  clockTolerance: 60

# Advanced & Ecosystem Features
# Uncomment and configure as needed
# redisUrl: "redis://localhost:6379"
# codeModeIsolation: "sandbox"
# proxySql:
#   host: "localhost"
#   port: 6032
#   username: "radmin"
#   password: "radmin"