Christian561 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 and write, validate, and execute queries. You can easily interact with your Gel database using natural language. Cheers to the code authors!

⚠️ Important Note

Query generation is not included because LLMs can write more flexible queries. Good results have been achieved using the Cursor agent (with Claude-3.7-sonnet-thinking) and providing Gel documentation.

🚀 Quick Start

Installation Steps

# 1. Install dependencies
yarn install

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

# 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 migrations if needed

# 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
# Edit the proxy section in src/index.ts
# Install dependencies:
# npm install @gel/core @gel/typescript gel-language-server --save-dev
# Configure tsconfig.json and jsconfig.json

# 6. Run the server
npm run dev

# 7. Use the proxy to query
curl http://localhost:3000/api/execute

✨ Features

Execute TypeScript

• Similar to execute-edgeql, but for testing and running TypeScript Gel queries written in the query builder syntax.
• The instructions are included in the tool, but it is still recommended that the agent loads these instructions to ensure they are not skipped.
• Note: JavaScript syntax errors may cause the server to crash. So, if the connection shows as closed, refresh the proxy in the Cursor MCP settings or restart the server.

💡 Usage Tip

Prompt the LLM with these best practices:

• Use await gelClient.query() and display the results with console.log.
• Use ORDER BY with THEN instead of commas (e.g., ORDER BY .field1 THEN .field2).
• Keep the code simple and focus on a single operation.

💻 Usage Examples

Basic Usage

console.log(await gelClient.query(`
  SELECT Product { 
    name, 
    price 
  } 
  FILTER .price > 100 
  ORDER BY .price DESC 
  LIMIT 5;
`));

📚 Documentation

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