<!-- markdownlint-disable MD041 -->

:star: Star it :arrow_heading_up: if you love it!

<img src="https://raw.githubusercontent.com/schemacrawler/SchemaCrawler/main/schemacrawler-website/src/site/resources/images/schemacrawler_logo.png" height="100px" width="100px" valign="middle"/> SchemaCrawler AI MCP Server: Usage

[!NOTE]

• Please see the SchemaCrawler website for more details.

About

SchemaCrawler is a free database schema discovery and comprehension tool. SchemaCrawler has a good mix of useful features for data governance. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format.

This is a bare project that acts as an MCP client for the SchemaCrawler AI MCP Server for use in "Agent" mode. You can find documentation on how to use the server here.

The SchemaCrawler AI MCP Server is available as a Docker image schemacrawler/schemacrawler-ai. It is also available from the the Docker MCP Catalog as a Docker-verified image.

Prerequisites

1. Install supporting software
   • Docker
   • Docker Compose
   • Visual Studio Code
2. Read Use MCP servers in VS Code
3. Clone this project, and open it in Visual Studio Code

Getting Started

Refer to the getting started documentation, and more documentation in docs/.