io.github.schemacrawler/schemacrawler-ai

Official

by schemacrawler · Java

Enables natural language schema queries — explore tables, keys, procedures, and get SQL help fast

Query database schemas using natural language to explore tables, keys, and get SQL assistance.

Topics

aidatabasedatabase-schemadocumentationjavamcpmcp-servermcp-serversmetadata-extractionreverse-engineeringschemaschemacrawler

Install

Configuration

Environment variables

SCHCRWLR_MCP_SERVER_TRANSPORT

MCP Server transport type - valid values are 'http' or 'stdio', defaulting to 'stdio'.

SCHCRWLR_DATABASE_USERsecret

Database user name. Can be optional depending on the database connection type.

SCHCRWLR_DATABASE_PASSWORDsecret

Database user password. Can be optional depending on the database connection type.

SCHCRWLR_JDBC_URL

JDBC URL for database connection. If this is provided, the server, host, port and database are not used.

SCHCRWLR_SERVER

SchemaCrawler database plugin, for example, 'sqlserver' or 'sqlite'. Used only if the JDBC URL is not provided.

SCHCRWLR_HOST

Database host. Defaults to localhost. Used only if the JDBC URL is not provided.

SCHCRWLR_PORT

Database port. Defaults to the default port for the server type. Used only if the JDBC URL is not provided.

SCHCRWLR_DATABASE

Database to connect to (optional). Used only if the JDBC URL is not provided.

SCHCRWLR_INFO_LEVEL

How much database metadata to retrieve. Values are 'minimum', 'standard', 'detailed' or 'maximum'.

SCHCRWLR_LOG_LEVEL

Logging verbosity level. Values are 'SEVERE', 'WARNING', 'INFO', 'CONFIG', or 'FINE'.

SCHCRWLR_EXCLUDE_TOOLS

MCP Server tools to exclude, as a comma-separated list.

claude_desktop_config.json

{
  "mcpServers": {
    "schemacrawler-ai": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "schemacrawler/schemacrawler-ai:17.11.4-3"
      ],
      "env": {
        "SCHCRWLR_MCP_SERVER_TRANSPORT": "<YOUR_SCHCRWLR_MCP_SERVER_TRANSPORT>",
        "SCHCRWLR_DATABASE_USER": "<YOUR_SCHCRWLR_DATABASE_USER>",
        "SCHCRWLR_DATABASE_PASSWORD": "<YOUR_SCHCRWLR_DATABASE_PASSWORD>",
        "SCHCRWLR_JDBC_URL": "<YOUR_SCHCRWLR_JDBC_URL>",
        "SCHCRWLR_SERVER": "<YOUR_SCHCRWLR_SERVER>",
        "SCHCRWLR_HOST": "<YOUR_SCHCRWLR_HOST>",
        "SCHCRWLR_PORT": "<YOUR_SCHCRWLR_PORT>",
        "SCHCRWLR_DATABASE": "<YOUR_SCHCRWLR_DATABASE>",
        "SCHCRWLR_INFO_LEVEL": "<YOUR_SCHCRWLR_INFO_LEVEL>",
        "SCHCRWLR_LOG_LEVEL": "<YOUR_SCHCRWLR_LOG_LEVEL>",
        "SCHCRWLR_EXCLUDE_TOOLS": "<YOUR_SCHCRWLR_EXCLUDE_TOOLS>"
      }
    }
  }
}

io.github.schemacrawler/schemacrawler-ai

Topics

<img src="https://github.com/schemacrawler/SchemaCrawler-Usage/blob/98e442d9a957070d45e87109d5b32d7f17b62927/schemacrawler-website/src/site/resources/images/schemacrawler_logo.png?raw=true" height="100px" width="100px" valign="middle"/> SchemaCrawler AI

About

Licensing

Support

Install

Configuration