OpenCode MySQL

OpenCode plugin that adds a MySQL Query tool for running SQL against a configured MySQL 8+ database.

Install

Add the plugin to your OpenCode config:

{
  "$schema": "https://opencode.ai/config.json",
  "plugin": ["opencode-mysql"]
}

Configure

Use tuple config to provide the MySQL connection string and read-only mode:

{
  "$schema": "https://opencode.ai/config.json",
  "plugin": [
    [
      "opencode-mysql",
      {
        "connectionString": "mysql://user:password@localhost:3306/database",
        "readOnly": true
      }
    ]
  ]
}

Options:

• connectionString: MySQL connection string. Required.
• readOnly: Run queries in a read-only transaction. Defaults to true.

Each tool call runs one SQL statement. Multi-statement execution remains disabled even if the connection string requests it.

Permissions

The tool uses OpenCode's native permission system with the mysql_query permission key. If permission.mysql_query is not configured, OpenCode's native fallback applies, which currently allows most permissions.

To ask before MySQL queries:

{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "mysql_query": "ask"
  }
}

You can also explicitly allow or deny the tool:

{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "mysql_query": "allow"
  }
}

{
  "$schema": "https://opencode.ai/config.json",
  "permission": {
    "mysql_query": "deny"
  }
}

Choosing always in a prompt allows additional MySQL queries for the current OpenCode session.

The tool is available as mysql_query and its description identifies whether it is configured as (read-only) or (read/write). It accepts one argument:

{
  "query": "select now()"
}

Use a database role with the minimum privileges needed. readOnly uses MySQL 8's transaction-level read-only mode, but MySQL still permits changes to temporary tables. Database permissions should be the source of truth.

Local Development

This package includes .opencode/plugins/mysql.ts, so OpenCode can load the local source directly while developing inside the package directory.

From the monorepo root:

npm install
npm run typecheck -w opencode-mysql
npm run build -w opencode-mysql
npm run smoke -w opencode-mysql

Restart OpenCode after plugin or config changes.

License

MIT