SchemaCrawler

Connect to any relational database, and be able to get valid SQL, and ask questions like what does a certain column prefix mean.

{{ message }}

schemacrawler / SchemaCrawler-MCP-Server-Usage Public

  • Notifications
  • Fork0
  • Star 2

Find out how to use SchemaCrawler MCP Server

www.schemacrawler.com/

2 stars0 forksBranches Tags Activity

Star

Notifications

main

BranchesTags

Go to file

Code

NameNameLast commit messageLast commit date
22 Commits
.github.github
.vscode.vscode
.gitignore.gitignore
schemacrawler-mcpserver-adventureworks.yamlschemacrawler-mcpserver-adventureworks.yaml
schemacrawler-mcpserver-sakila.yamlschemacrawler-mcpserver-sakila.yaml
schemacrawler-mcpserver.yamlschemacrawler-mcpserver.yaml
View all files

Repository files navigation

Docker Pulls GitHub Repo stars

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

  1. Supporting software
    • Docker
    • Docker Compose
    • Visual Studio Code
  2. Clone this projects, and open it in Visual Studio Code

Start the SchemaCrawler MCP Server

  1. Pull the latest image for SchemaCrawler MCP Server
    docker pull schemacrawler/schemacrawler:extra-early-access-release
  2. Run the SchemaCrawler MCP Server
    docker compose -f schemacrawler-mcpserver.yaml up -d
  3. Check server health in a browser http://localhost:8080/health

Use Visual Studio Code MCP Client

  1. Read Use MCP servers in VS Code
  2. Connect to the MCP Server in Visual Studio Code (the server is configured in the ".vscode/mcp.json" file)
  3. 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"

Connect to Your Database

  1. Stop the SchemaCrawler MCP Server
    docker compose -f schemacrawler-mcpserver.yaml down -t0
  2. Edit the "schemacrawler-mcpserver.yaml" file to add your database connection details
  3. Restart the SchemaCrawler MCP Server

About

Readme

Activity

2 stars

1 watching

0 forks

Report repository

Releases

4 tags

Contributors2

Related Servers