Christian561 Gel MCP Server

🚀 Gel 數據庫 MCP 服務器

Gel 數據庫 MCP 服務器是一個基於 TypeScript 的 Model Context Protocol (MCP) 服務器，它藉助 EdgeQL 查詢簡化了 Gel 數據庫操作。該項目為 LLM 代理（如 Cursor Agent、Claude Code 等）提供工具，使其能自動學習數據庫架構，編寫、驗證和執行查詢，讓用戶可以通過自然語言輕鬆與 Gel 數據庫交互。代碼開發者的福音！

⚠️ 重要提示

查詢生成不在此項目範圍內，因為 LLM 可以編寫更靈活的查詢。使用 Cursor 代理（帶有 Claude - 3.7 - sonnet - thinking）並提供 Gel 文檔後能取得良好效果。

🚀 快速開始

安裝與初始化

# 1. 安裝依賴項
yarn install

# 2. 如果您已經有 dbschema 文件夾，請將其複製到項目中
# cp -r /path/to/your/dbschema ./
# 或直接複製粘貼

# 3. 初始化 Gel 項目
npx gel project init
# 按照提示設置新項目
# 可以通過提供實例名稱指向現有 Gel 實例
#   - 如果需要，導入遷移

# 4. 生成 EdgeQL JavaScript 查詢構建器文件
npx @gel/generate edgeql-js
# 注意：在任何架構更改後重新運行此命令

# 5. 更新連接設置
# 編輯 src/index.ts 中的代理部分
# 安裝依賴項：
# npm install @gel/core @gel/typescript gel-language-server --save-dev
# 配置 tsconfig.json 和 jsconfig.json

# 6. 運行服務器
npm run dev

# 7. 使用代理進行查詢
curl http://localhost:3000/api/execute

✨ 主要特性

執行 TypeScript

• 類似於 execute - edgeql，但用於測試和運行用查詢構建器語法編寫的 TypeScript Gel 查詢。
• 指令包含在工具中，但仍建議代理加載這些指令以確保它們不會被跳過。
• 注意：JavaScript 語法錯誤可能會導致服務器崩潰，因此如果連接顯示為已關閉，請刷新 Cursor MCP 設置中的代理或重新啟動服務器。

💡 使用建議

• 使用 await gelClient.query() 並用 console.log 顯示結果
• 使用 ORDER BY 帶有 THEN 而不是逗號（例如，ORDER BY .field1 THEN .field2）
• 保持代碼簡單並專注於單一操作

基礎用法

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

📚 詳細文檔

有關 Model Context Protocol 的更多信息，請訪問 modelcontextprotocol.io/quickstart。