SchemaCrawler - MCP Server Usage
Note
- Please see the SchemaCrawler website for more details.
- Explore the SchemaCrawler command-line with a live online tutorial.
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 MCP Server for use in "Agent" mode.
Prerequisites
- Supporting software
- Docker
- Docker Compose
- Visual Studio Code
- Clone this projects, and open it in Visual Studio Code
Start the SchemaCrawler MCP Server
- Pull the latest image for SchemaCrawler MCP Server
docker pull schemacrawler/schemacrawler-ai:latest - Run the SchemaCrawler MCP Server
docker compose -f schemacrawler-mcpserver.yaml up -d - Check server health in a browser http://localhost:9292/health
Use Visual Studio Code MCP Client
- Read Use MCP servers in VS Code
- Connect to the MCP Server in Visual Studio Code (the server is configured in the ".vscode/mcp.json" file)
- Ask questions about your database in "Agent" mode - here are some examples:
- "What tables are available in my database?"
- "Show me the columns in the Books table"
- "What foreign keys reference the Authors table?"
- "Are there any design issues with my database schema?"
- "Write SQL to find books and their authors"
- Additional "Agent" modes are provided in this project too. Use the "database-expert" or "sql-query-assistant" modes for fine-tuned help for specific tasks.
Use Other MCP Clients
Try other MCP Clients too.
- Microsoft AI Shell for a shell
- ... and more at Awesome MCP Clients
Connect to Your Database
- Stop the SchemaCrawler MCP Server
docker compose -f schemacrawler-mcpserver.yaml down -t0 - Edit the "schemacrawler-mcpserver.yaml" file to add your database connection details
- Restart the SchemaCrawler MCP Server