Gel MCP Server

🚀 Gel Database MCP Server

A TypeScript-based Model Context Protocol (MCP) server designed to simplify Gel database operations through EdgeQL queries. This project offers tools for LLM agents (such as Cursor Agent, Claude Code, etc.) to automatically learn the database schema, as well as write, validate, and execute database queries. You can easily interact with your Gel database using natural language. Coders, rejoice!

⚠️ Important Note

Query generation is not within the scope of this project, as LLMs can write more flexible queries. After using the Cursor agent and providing the Gel documentation, testing with Claude-3.7-sonnet-thinking by linking relevant web pages yielded good results.

🚀 Quick Start

# 1. Install dependencies
yarn install

# 2. If you already have a dbschema folder, copy it into the project
# cp -r /path/to/your/dbschema ./
# or simply copy and paste

# 3. Initialize the Gel project
npx gel project init
# Follow the prompts to set up a new project
# You can point to an existing gel instance by providing the instance name
#   - Import migration files if prompted

# 4. Generate EdgeQL JavaScript query builder files
npx @gel/generate edgeql-js
# Note: Re-run this command after any schema changes

# 5. Update connection settings
# Refer to [Database Connection](https://example.com/database-connection) for more information.

# 6. Start the server
npm start

💻 Usage Examples

Search Gel Documentation

searchTerm: "for loop"
contextLines: 10  # Optional: Number of context lines to display (Default: 5)
matchAllTerms: true  # Optional: Require all terms to match (Default: false)

📚 Documentation

For more information about the Model Context Protocol, please visit modelcontextprotocol.io/quickstart.