GQL Language Server Protocol Implementation Guide

<h3 id="overview" class="position-relative d-flex align-items-center group"> Overview <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="overview" aria-haspopup="dialog" aria-label="Share link: Overview"> Share link </button> </h3><div id="headingShareModal" class="heading-share-modal" role="dialog" aria-modal="true" aria-labelledby="headingShareTitle" hidden> <div class="hsm-dialog" role="document"> <div class="hsm-header"> <h2 id="headingShareTitle" class="h6 mb-0 fw-bold">Share this section</h2> <button type="button" class="hsm-close" aria-label="Close"> </button> </div> <div class="hsm-body"> <label for="headingShareInput" class="form-label small text-muted mb-1 text-uppercase fw-bold" style="font-size: 0.7rem; letter-spacing: 0.5px;">Permalink</label> <div class="input-group mb-4 hsm-url-group"> <input id="headingShareInput" type="text" class="form-control font-monospace" readonly aria-readonly="true" style="font-size: 0.85rem;" /> <button class="btn btn-primary hsm-copy" type="button" aria-label="Copy" title="Copy"> </button> </div> <div class="small fw-bold mb-2 text-muted text-uppercase" style="font-size: 0.7rem; letter-spacing: 0.5px;">Share via</div> <div class="hsm-share-grid"> <a id="share-twitter" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Twitter </a> <a id="share-linkedin" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> LinkedIn </a> <a id="share-facebook" class="btn btn-outline-secondary w-100" target="_blank" rel="noopener noreferrer"> Facebook </a> </div> </div> </div> </div> <style> .heading-share-modal { position: fixed; inset: 0; display: flex; justify-content: center; align-items: center; background: rgba(0, 0, 0, 0.6); z-index: 1050; padding: 1rem; backdrop-filter: blur(4px); -webkit-backdrop-filter: blur(4px); } .heading-share-modal[hidden] { display: none !important; } .hsm-dialog { max-width: 420px; width: 100%; background: var(--bs-body-bg, #fff); color: var(--bs-body-color, #212529); border: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); border-radius: 1rem; box-shadow: 0 25px 50px -12px rgba(0, 0, 0, 0.25); overflow: hidden; animation: hsm-fade-in 0.2s ease-out; } @keyframes hsm-fade-in { from { opacity: 0; transform: scale(0.95); } to { opacity: 1; transform: scale(1); } } [data-bs-theme="dark"] .hsm-dialog { background: #1e293b; border-color: rgba(255,255,255,0.1); color: #f8f9fa; } .hsm-header { display: flex; justify-content: space-between; align-items: center; padding: 1rem 1.5rem; border-bottom: 1px solid var(--bs-border-color, rgba(0,0,0,0.1)); background: rgba(0,0,0,0.02); } [data-bs-theme="dark"] .hsm-header { background: rgba(255,255,255,0.02); border-color: rgba(255,255,255,0.1); } .hsm-close { background: transparent; border: none; color: inherit; opacity: 0.5; padding: 0.25rem 0.5rem; border-radius: 0.25rem; font-size: 1.2rem; line-height: 1; transition: opacity 0.2s; } .hsm-close:hover { opacity: 1; } .hsm-body { padding: 1.5rem; } .hsm-url-group { display: flex !important; align-items: stretch; } .hsm-url-group .form-control { flex: 1; min-width: 0; margin: 0; background: var(--bs-secondary-bg, #f8f9fa); border-color: var(--bs-border-color, #dee2e6); border-top-right-radius: 0; border-bottom-right-radius: 0; height: 42px; } .hsm-url-group .btn { flex: 0 0 auto; margin: 0; margin-left: -1px; border-top-left-radius: 0; border-bottom-left-radius: 0; height: 42px; display: flex; align-items: center; justify-content: center; padding: 0 1.25rem; z-index: 2; } [data-bs-theme="dark"] .hsm-url-group .form-control { background: #0f172a; border-color: #334155; color: #e2e8f0; } .hsm-share-grid { display: flex; flex-direction: column; gap: 0.5rem; } .hsm-share-grid .btn { display: flex; align-items: center; justify-content: center; font-size: 0.9rem; padding: 0.6rem; border-color: var(--bs-border-color); width: 100%; } [data-bs-theme="dark"] .hsm-share-grid .btn { color: #e2e8f0; border-color: #475569; } [data-bs-theme="dark"] .hsm-share-grid .btn:hover { background: #334155; border-color: #cbd5e1; } </style> <script> (function(){ const modal = document.getElementById('headingShareModal'); if(!modal) return; const input = modal.querySelector('#headingShareInput'); const copyBtn = modal.querySelector('.hsm-copy'); const twitter = modal.querySelector('#share-twitter'); const linkedin = modal.querySelector('#share-linkedin'); const facebook = modal.querySelector('#share-facebook'); const closeBtn = modal.querySelector('.hsm-close'); let lastFocus=null; let trapBound=false; function buildUrl(id){ return window.location.origin + window.location.pathname + '#' + id; } function isOpen(){ return !modal.hasAttribute('hidden'); } function hydrate(id){ const url=buildUrl(id); input.value=url; const enc=encodeURIComponent(url); const text=encodeURIComponent(document.title); if(twitter) twitter.href=`https://twitter.com/intent/tweet?url=${enc}&text=${text}`; if(linkedin) linkedin.href=`https://www.linkedin.com/sharing/share-offsite/?url=${enc}`; if(facebook) facebook.href=`https://www.facebook.com/sharer/sharer.php?u=${enc}`; } function openModal(id){ lastFocus=document.activeElement; hydrate(id); if(!isOpen()){ modal.removeAttribute('hidden'); } requestAnimationFrame(()=>{ input.focus(); }); trapFocus(); } function closeModal(){ if(!isOpen()) return; modal.setAttribute('hidden',''); if(lastFocus && typeof lastFocus.focus==='function') lastFocus.focus(); } function copyCurrent(){ try{ navigator.clipboard.writeText(input.value).then(()=>feedback(true),()=>fallback()); } catch(e){ fallback(); } } function fallback(){ input.select(); try{ document.execCommand('copy'); feedback(true);}catch(e){ feedback(false);} } function feedback(ok){ if(!copyBtn) return; const icon=copyBtn.querySelector('i'); if(!icon) return; const prev=copyBtn.getAttribute('data-prev')||icon.className; if(!copyBtn.getAttribute('data-prev')) copyBtn.setAttribute('data-prev',prev); icon.className= ok ? 'fa-duotone fa-clipboard-check':'fa-duotone fa-circle-exclamation'; setTimeout(()=>{ icon.className=prev; },1800); } function handleShareClick(e){ e.preventDefault(); const btn=e.currentTarget; const id=btn.getAttribute('data-share-target'); if(id) openModal(id); } function bindShareButtons(){ document.querySelectorAll('.h-share').forEach(btn=>{ if(!btn.dataset.hShareBound){ btn.addEventListener('click', handleShareClick); btn.dataset.hShareBound='1'; } }); } bindShareButtons(); if(document.readyState==='loading'){ document.addEventListener('DOMContentLoaded', bindShareButtons); } else { requestAnimationFrame(bindShareButtons); } document.addEventListener('click', function(e){ const shareBtn=e.target.closest && e.target.closest('.h-share'); if(shareBtn && !shareBtn.dataset.hShareBound){ handleShareClick.call(shareBtn, e); } }, true); document.addEventListener('click', e=>{ if(e.target===modal) closeModal(); if(e.target.closest && e.target.closest('.hsm-close')){ e.preventDefault(); closeModal(); } if(copyBtn && (e.target===copyBtn || (e.target.closest && e.target.closest('.hsm-copy')))) { e.preventDefault(); copyCurrent(); } }); document.addEventListener('keydown', e=>{ if(e.key==='Escape' && isOpen()) closeModal(); }); function trapFocus(){ if(trapBound) return; trapBound=true; modal.addEventListener('keydown', f=>{ if(f.key==='Tab' && isOpen()){ const focusable=[...modal.querySelectorAll('a[href],button,input,textarea,select,[tabindex]:not([tabindex="-1"])')].filter(el=>!el.hasAttribute('disabled')); if(!focusable.length) return; const first=focusable[0]; const last=focusable[focusable.length-1]; if(f.shiftKey && document.activeElement===first){ f.preventDefault(); last.focus(); } else if(!f.shiftKey && document.activeElement===last){ f.preventDefault(); first.focus(); } } }); } if(closeBtn) closeBtn.addEventListener('click', e=>{ e.preventDefault(); closeModal(); }); })(); </script>Geode provides a complete Language Server Protocol (LSP) implementation for GQL files, bringing professional IDE features to graph query development. The LSP server delivers real-time syntax checking, intelligent code completion, hover documentation, and more. Status: Production-ready (100% implemented and tested) <h4 id="what-youll-learn" class="position-relative d-flex align-items-center group"> What You&rsquo;ll Learn <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="what-youll-learn" aria-haspopup="dialog" aria-label="Share link: What Youll Learn"> Share link </button> </h4><ul> <li>How to set up Geode LSP with your IDE</li> <li>Available language features and capabilities</li> <li>Integration guides for VS Code, Neovim, Vim, and Emacs</li> <li>Troubleshooting common LSP issues</li> <li>Advanced configuration options</li> </ul> <h4 id="prerequisites" class="position-relative d-flex align-items-center group"> Prerequisites <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="prerequisites" aria-haspopup="dialog" aria-label="Share link: Prerequisites"> Share link </button> </h4><ul> <li>Geode installed (see <a href="/guides/installation/" >Installation Guide</a> )</li> <li>Basic familiarity with your IDE’s plugin/extension system</li> <li>For VS Code: Node.js and npm</li> <li>For Neovim: nvim-lspconfig plugin</li> </ul> <h3 id="starting-language-servers" class="position-relative d-flex align-items-center group"> Starting Language Servers <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="starting-language-servers" aria-haspopup="dialog" aria-label="Share link: Starting Language Servers"> Share link </button> </h3>Geode provides two language server modes: LSP for IDE integration and MCP for AI assistant integration. <h4 id="lsp-server-language-server-protocol" class="position-relative d-flex align-items-center group"> LSP Server (Language Server Protocol) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="lsp-server-language-server-protocol" aria-haspopup="dialog" aria-label="Share link: LSP Server (Language Server Protocol)"> Share link </button> </h4>The LSP server provides IDE features like autocomplete, hover documentation, and diagnostics. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start the LSP server (communicates via stdin/stdout) geode lsp # With verbose logging geode lsp --verbose # Specify log file for debugging geode lsp --log-file=/tmp/geode-lsp.log </code></pre></div>The LSP server is typically launched automatically by your IDE, but you can test it manually: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Test LSP initialization echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"capabilities":{}}}' | geode lsp </code></pre></div> <h4 id="mcp-server-model-context-protocol" class="position-relative d-flex align-items-center group"> MCP Server (Model Context Protocol) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="mcp-server-model-context-protocol" aria-haspopup="dialog" aria-label="Share link: MCP Server (Model Context Protocol)"> Share link </button> </h4>The MCP server provides AI assistants (like Claude) with direct access to Geode. <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start the MCP server geode mcp serve # Connect to a specific Geode instance geode mcp serve --host localhost --port 3141 # With authentication geode mcp serve --host localhost --port 3141 --user admin --password secret # With verbose output geode mcp serve --verbose </code></pre></div>MCP Server Configuration via environment variables: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Set connection details via environment export GEODE_HOST=localhost export GEODE_PORT=3141 export GEODE_USER=admin export GEODE_PASSWORD=secret geode mcp serve </code></pre></div> <h4 id="running-both-servers" class="position-relative d-flex align-items-center group"> Running Both Servers <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="running-both-servers" aria-haspopup="dialog" aria-label="Share link: Running Both Servers"> Share link </button> </h4>For full development experience with both IDE support and AI assistance: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Terminal 1: Start Geode database server geode serve --listen 0.0.0.0:3141 # Terminal 2: Your IDE uses LSP (automatically started) # Configure your IDE to run: geode lsp # Terminal 3: AI assistant uses MCP geode mcp serve --host localhost --port 3141 </code></pre></div> <h4 id="claude-code-integration" class="position-relative d-flex align-items-center group"> Claude Code Integration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="claude-code-integration" aria-haspopup="dialog" aria-label="Share link: Claude Code Integration"> Share link </button> </h4>To use Geode with Claude Code: <ol> <li>Configure MCP in Claude settings:</li> </ol> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "mcpServers": { "geode": { "command": "geode", "args": ["mcp", "serve", "--host", "localhost", "--port", "3141"] } } } </code></pre></div><ol start="2"> <li>Or use the Geode Claude plugin:</li> </ol> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Install the plugin claude plugins install geode-claude-plugin # Or run with local plugin directory claude --plugin-dir ./geode-claude-plugin </code></pre></div>See the <a href="/plugins/claude/" >Claude Code Plugin</a> documentation for more details. <h3 id="architecture" class="position-relative d-flex align-items-center group"> Architecture <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="architecture" aria-haspopup="dialog" aria-label="Share link: Architecture"> Share link </button> </h3> <h4 id="components" class="position-relative d-flex align-items-center group"> Components <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="components" aria-haspopup="dialog" aria-label="Share link: Components"> Share link </button> </h4>The Geode LSP implementation consists of five main components: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">src/cli/lsp/ ├── protocol.zig # LSP protocol types and JSON-RPC structures ├── transport.zig # stdio transport with Content-Length headers ├── document.zig # Document state management ├── features.zig # Language features (hover, completion, diagnostics) └── server.zig # Main LSP server implementation </code></pre></div> <h4 id="protocol-compliance" class="position-relative d-flex align-items-center group"> Protocol Compliance <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="protocol-compliance" aria-haspopup="dialog" aria-label="Share link: Protocol Compliance"> Share link </button> </h4><ul> <li>LSP Specification: 3.17</li> <li>Transport: JSON-RPC 2.0 over stdin/stdout</li> <li>Text Synchronization: Full and Incremental modes</li> <li>Parser Integration: Uses Geode’s ISO/IEC 39075:2024 compliance parser</li> </ul> <h4 id="server-capabilities" class="position-relative d-flex align-items-center group"> Server Capabilities <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="server-capabilities" aria-haspopup="dialog" aria-label="Share link: Server Capabilities"> Share link </button> </h4>The LSP server advertises the following capabilities during initialization: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "capabilities": { "textDocumentSync": 1, "hoverProvider": true, "completionProvider": { "triggerCharacters": [".", ":", "$"] }, "diagnosticProvider": true } } </code></pre></div> <h3 id="language-features" class="position-relative d-flex align-items-center group"> Language Features <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="language-features" aria-haspopup="dialog" aria-label="Share link: Language Features"> Share link </button> </h3> <h4 id="1-diagnostics-syntax-errors" class="position-relative d-flex align-items-center group"> 1. Diagnostics (Syntax Errors) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="1-diagnostics-syntax-errors" aria-haspopup="dialog" aria-label="Share link: 1. Diagnostics (Syntax Errors)"> Share link </button> </h4>Real-time syntax error detection using Geode’s GQL parser: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">-- Invalid syntax (missing closing parenthesis) MATCH (n:Person RETURN n.name -- Error: Expected ')' at line 1, column 16 </code></pre></div>Features: <ul> <li>Instant feedback as you type</li> <li>Line and column precision</li> <li>Clear error messages from the parser</li> <li>Multiple error reporting</li> </ul> <h4 id="2-hover-documentation" class="position-relative d-flex align-items-center group"> 2. Hover Documentation <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="2-hover-documentation" aria-haspopup="dialog" aria-label="Share link: 2. Hover Documentation"> Share link </button> </h4>Context-aware documentation for GQL keywords, functions, and types: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MATCH (n:Person) WHERE n.age > 25 RETURN distance(n.embedding, $query, 'L2') -- ^^^^^^^^ Hover shows: "distance(v1: VECTOR, v2: VECTOR) -> FLOAT" </code></pre></div>Supported Items (100+ documented): <ul> <li>Keywords (40+): MATCH, RETURN, WHERE, CREATE, DELETE, MERGE, etc.</li> <li>Functions (50+): count, sum, distance, similarity, timestamp, etc.</li> <li>Types (15+): INTEGER, FLOAT, VECTOR, UUID, DATETIME, etc.</li> </ul> Example Documentation: Hovering over <code>distance</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">distance(v1: VECTOR, v2: VECTOR, metric: STRING) -> FLOAT Calculate distance between two vectors using the specified metric. Supported metrics: - 'L2' or 'euclidean': Euclidean distance - 'cosine': Cosine distance - 'manhattan': Manhattan (L1) distance - 'dot': Dot product Example: RETURN distance(n.embedding, $query, 'L2') </code></pre></div> <h4 id="3-code-completion" class="position-relative d-flex align-items-center group"> 3. Code Completion <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="3-code-completion" aria-haspopup="dialog" aria-label="Share link: 3. Code Completion"> Share link </button> </h4>Intelligent auto-complete for GQL syntax: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">MA<cursor> -- Suggests: MATCH, MAX, MANHATTAN RETURN co<cursor> -- Suggests: count(), coalesce(), collect(), cos(), cosine() WHERE n.<cursor> -- Triggers property completion (when connected to server) </code></pre></div>Completion Types: <ul> <li>Keywords: All GQL keywords with proper context</li> <li>Functions: Function names with <code>()</code> insertion</li> <li>Types: Data type names</li> <li>Parameters: Variable names starting with <code>$</code></li> </ul> Trigger Characters: <ul> <li><code>.</code> - Property access</li> <li><code>:</code> - Label specification</li> <li><code>$</code> - Parameter names</li> </ul> <h4 id="4-document-synchronization" class="position-relative d-flex align-items-center group"> 4. Document Synchronization <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="4-document-synchronization" aria-haspopup="dialog" aria-label="Share link: 4. Document Synchronization"> Share link </button> </h4>The LSP server maintains document state using two synchronization modes: Full Synchronization: <ul> <li>Server receives complete document text on every change</li> <li>Simpler implementation, suitable for smaller files</li> <li>Default mode</li> </ul> Incremental Synchronization: <ul> <li>Server receives only changed text ranges</li> <li>More efficient for large files</li> <li>Supported but Full mode is default</li> </ul> <h3 id="ide-integration" class="position-relative d-flex align-items-center group"> IDE Integration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="ide-integration" aria-haspopup="dialog" aria-label="Share link: IDE Integration"> Share link </button> </h3> <h4 id="visual-studio-code" class="position-relative d-flex align-items-center group"> Visual Studio Code <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="visual-studio-code" aria-haspopup="dialog" aria-label="Share link: Visual Studio Code"> Share link </button> </h4> <h5 id="option-1-manual-configuration" class="position-relative d-flex align-items-center group"> Option 1: Manual Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="option-1-manual-configuration" aria-haspopup="dialog" aria-label="Share link: Option 1: Manual Configuration"> Share link </button> </h5>Add to your <code>settings.json</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "gql.server.enable": true, "gql.server.path": "/path/to/geode", "gql.server.args": ["lsp"], "gql.trace.server": "verbose" } </code></pre></div>Create a file type association for <code>.gql</code> files: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "files.associations": { "*.gql": "gql", "*.gcypher": "gql", "*.cypher": "gql" } } </code></pre></div> <h5 id="option-2-vs-code-extension" class="position-relative d-flex align-items-center group"> Option 2: VS Code Extension <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="option-2-vs-code-extension" aria-haspopup="dialog" aria-label="Share link: Option 2: VS Code Extension"> Share link </button> </h5>A complete VS Code extension is available in the repository: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd editors/vscode npm install npm run compile npx vsce package # Install the .vsix file in VS Code </code></pre></div>Extension Features: <ul> <li>TextMate grammar for syntax highlighting</li> <li>Automatic LSP client configuration</li> <li>Configurable server path and arguments</li> <li>GQL language snippets</li> <li>File icon themes</li> </ul> Extension Settings: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "geode.lspPath": "/usr/local/bin/geode", "geode.lspArgs": ["lsp"], "geode.trace.server": "off" } </code></pre></div> <h4 id="neovim" class="position-relative d-flex align-items-center group"> Neovim <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="neovim" aria-haspopup="dialog" aria-label="Share link: Neovim"> Share link </button> </h4> <h5 id="using-nvim-lspconfig" class="position-relative d-flex align-items-center group"> Using nvim-lspconfig <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="using-nvim-lspconfig" aria-haspopup="dialog" aria-label="Share link: Using nvim-lspconfig"> Share link </button> </h5>Create <code>~/.config/nvim/lua/lsp/geode.lua</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">local lspconfig = require('lspconfig') local configs = require('lspconfig.configs') -- Define Geode LSP server if not configs.geode then configs.geode = { default_config = { cmd = {'/usr/local/bin/geode', 'lsp'}, filetypes = {'gql', 'gcypher', 'cypher'}, root_dir = function(fname) return lspconfig.util.find_git_ancestor(fname) or vim.fn.getcwd() end, settings = {}, }, } end -- Set up Geode LSP lspconfig.geode.setup{ on_attach = function(client, bufnr) -- Key mappings local opts = { noremap=true, silent=true, buffer=bufnr } vim.keymap.set('n', 'gd', vim.lsp.buf.definition, opts) vim.keymap.set('n', 'K', vim.lsp.buf.hover, opts) vim.keymap.set('n', 'gi', vim.lsp.buf.implementation, opts) vim.keymap.set('n', '<leader>rn', vim.lsp.buf.rename, opts) vim.keymap.set('n', '<leader>ca', vim.lsp.buf.code_action, opts) vim.keymap.set('n', 'gr', vim.lsp.buf.references, opts) vim.keymap.set('n', '<leader>f', function() vim.lsp.buf.format { async = true } end, opts) -- Enable completion vim.api.nvim_buf_set_option(bufnr, 'omnifunc', 'v:lua.vim.lsp.omnifunc') end, capabilities = require('cmp_nvim_lsp').default_capabilities(), } </code></pre></div>Add to <code>init.lua</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">require('lsp.geode') </code></pre></div> <h5 id="file-type-detection" class="position-relative d-flex align-items-center group"> File Type Detection <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="file-type-detection" aria-haspopup="dialog" aria-label="Share link: File Type Detection"> Share link </button> </h5>Add to <code>~/.config/nvim/ftdetect/gql.vim</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">au BufRead,BufNewFile *.gql setfiletype gql au BufRead,BufNewFile *.gcypher setfiletype gql au BufRead,BufNewFile *.cypher setfiletype gql </code></pre></div> <h4 id="vim" class="position-relative d-flex align-items-center group"> Vim <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="vim" aria-haspopup="dialog" aria-label="Share link: Vim"> Share link </button> </h4>Using vim-lsp plugin: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">if executable('geode') au User lsp_setup call lsp#register_server({ \ 'name': 'geode-lsp', \ 'cmd': {server_info->['geode', 'lsp']}, \ 'allowlist': ['gql'], \ }) endif " Key mappings function! s:on_lsp_buffer_enabled() abort setlocal omnifunc=lsp#complete setlocal signcolumn=yes nmap <buffer> gd <plug>(lsp-definition) nmap <buffer> K <plug>(lsp-hover) nmap <buffer> <leader>rn <plug>(lsp-rename) nmap <buffer> [g <plug>(lsp-previous-diagnostic) nmap <buffer> ]g <plug>(lsp-next-diagnostic) endfunction augroup lsp_install au! autocmd User lsp_buffer_enabled call s:on_lsp_buffer_enabled() augroup END </code></pre></div> <h4 id="emacs" class="position-relative d-flex align-items-center group"> Emacs <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="emacs" aria-haspopup="dialog" aria-label="Share link: Emacs"> Share link </button> </h4>Using lsp-mode: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-elisp" data-lang="elisp">(add-to-list 'lsp-language-id-configuration '(gql-mode . "gql")) (lsp-register-client (make-lsp-client :new-connection (lsp-stdio-connection '("geode" "lsp")) :major-modes '(gql-mode) :server-id 'geode-lsp)) ;; Define gql-mode (simple) (define-derived-mode gql-mode fundamental-mode "GQL" "Major mode for GQL graph query language." (setq-local comment-start "//") (setq-local comment-end "")) ;; Associate file extensions (add-to-list 'auto-mode-alist '("\\.gql\\'" . gql-mode)) (add-to-list 'auto-mode-alist '("\\.gcypher\\'" . gql-mode)) (add-to-list 'auto-mode-alist '("\\.cypher\\'" . gql-mode)) ;; Start LSP in gql-mode (add-hook 'gql-mode-hook #'lsp) </code></pre></div> <h3 id="starting-the-lsp-server" class="position-relative d-flex align-items-center group"> Starting the LSP Server <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="starting-the-lsp-server" aria-haspopup="dialog" aria-label="Share link: Starting the LSP Server"> Share link </button> </h3> <h4 id="command-line-usage" class="position-relative d-flex align-items-center group"> Command-Line Usage <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="command-line-usage" aria-haspopup="dialog" aria-label="Share link: Command-Line Usage"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Start the LSP server (communicates via stdin/stdout) geode lsp # With verbose logging (to stderr) GEODE_LSP_DEBUG=1 geode lsp 2> /tmp/geode-lsp.log </code></pre></div> <h4 id="help-information" class="position-relative d-flex align-items-center group"> Help Information <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="help-information" aria-haspopup="dialog" aria-label="Share link: Help Information"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode lsp --help </code></pre></div>Output: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">geode lsp - Language Server Protocol server for GQL/Geode Usage: geode lsp [options] Description: Starts a Language Server Protocol (LSP) server for GQL files. The server communicates via JSON-RPC over stdin/stdout and provides: - Syntax error diagnostics - Hover documentation for GQL keywords, functions, and types - Code completion for GQL syntax - Document formatting Options: -h, --help Show this help message </code></pre></div> <h4 id="environment-variables" class="position-relative d-flex align-items-center group"> Environment Variables <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="environment-variables" aria-haspopup="dialog" aria-label="Share link: Environment Variables"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Enable debug logging export GEODE_LSP_DEBUG=1 # Set log file export GEODE_LSP_LOG=/tmp/geode-lsp.log # Set log level (debug, info, warn, error) export GEODE_LSP_LOG_LEVEL=debug </code></pre></div> <h3 id="testing-the-lsp-server" class="position-relative d-flex align-items-center group"> Testing the LSP Server <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="testing-the-lsp-server" aria-haspopup="dialog" aria-label="Share link: Testing the LSP Server"> Share link </button> </h3> <h4 id="manual-testing" class="position-relative d-flex align-items-center group"> Manual Testing <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="manual-testing" aria-haspopup="dialog" aria-label="Share link: Manual Testing"> Share link </button> </h4>Create a test file <code>test.gql</code>: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Sample GQL query for testing LSP features MATCH (p:Person)-[:KNOWS]->(f:Person) WHERE p.age > 25 RETURN p.name, f.name, distance(p.embedding, f.embedding, 'L2') AS similarity ORDER BY similarity ASC LIMIT 10 </code></pre></div>Start the server manually: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode lsp </code></pre></div>Send an initialize request (JSON-RPC): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">Content-Length: 250 { "jsonrpc": "2.0", "id": 1, "method": "initialize", "params": { "processId": null, "rootUri": "file:///path/to/workspace", "capabilities": {} } } </code></pre></div>The server responds with its capabilities: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "jsonrpc": "2.0", "id": 1, "result": { "capabilities": { "textDocumentSync": 1, "hoverProvider": true, "completionProvider": { "triggerCharacters": [".", ":", "$"] } } } } </code></pre></div> <h4 id="automated-testing" class="position-relative d-flex align-items-center group"> Automated Testing <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="automated-testing" aria-haspopup="dialog" aria-label="Share link: Automated Testing"> Share link </button> </h4>The LSP implementation includes 79 comprehensive tests: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Run all LSP tests zig test src/cli/lsp/test_runner.zig # Run specific test files zig test src/cli/lsp/protocol_test.zig # 23 tests zig test src/cli/lsp/document_test.zig # 28 tests zig test src/cli/lsp/features_test.zig # 24 tests zig test src/cli/lsp/server_test.zig # 4 tests zig test src/cli/lsp/e2e_test.zig # 13 tests </code></pre></div>Test Coverage: <ul> <li>Protocol structures and JSON-RPC (100%)</li> <li>Document management and navigation (100%)</li> <li>Language features (diagnostics, hover, completion) (100%)</li> <li>Server lifecycle and state management (100%)</li> <li>End-to-end workflows (100%)</li> </ul> <h3 id="performance" class="position-relative d-flex align-items-center group"> Performance <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="performance" aria-haspopup="dialog" aria-label="Share link: Performance"> Share link </button> </h3> <h4 id="benchmarks" class="position-relative d-flex align-items-center group"> Benchmarks <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="benchmarks" aria-haspopup="dialog" aria-label="Share link: Benchmarks"> Share link </button> </h4>Syntax Highlighting: <ul> <li>Small query (< 100 chars): < 1µs</li> <li>Medium query (< 1000 chars): < 10µs</li> <li>Large query (< 10000 chars): < 100µs</li> </ul> Diagnostics (Parser): <ul> <li>Small file (< 100 lines): < 5ms</li> <li>Medium file (< 1000 lines): < 50ms</li> <li>Large file (< 10000 lines): < 500ms</li> </ul> Hover and Completion: <ul> <li>Response time: < 1ms (cached documentation)</li> <li>First request: < 10ms (documentation loading)</li> </ul> Memory Usage: <ul> <li>Base server: ~12MB</li> <li>Per document: ~1KB + document size</li> <li>Efficient document storage with hash map lookups</li> </ul> <h3 id="advanced-configuration" class="position-relative d-flex align-items-center group"> Advanced Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="advanced-configuration" aria-haspopup="dialog" aria-label="Share link: Advanced Configuration"> Share link </button> </h3> <h4 id="custom-trigger-characters" class="position-relative d-flex align-items-center group"> Custom Trigger Characters <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="custom-trigger-characters" aria-haspopup="dialog" aria-label="Share link: Custom Trigger Characters"> Share link </button> </h4>Configure additional completion triggers in your IDE: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "completionProvider": { "triggerCharacters": [".", ":", "$", "(", "["] } } </code></pre></div> <h4 id="document-formatting" class="position-relative d-flex align-items-center group"> Document Formatting <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="document-formatting" aria-haspopup="dialog" aria-label="Share link: Document Formatting"> Share link </button> </h4>The LSP server supports basic document formatting: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "method": "textDocument/formatting", "params": { "textDocument": { "uri": "file:///path/to/file.gql" }, "options": { "tabSize": 2, "insertSpaces": true } } } </code></pre></div> <h4 id="workspace-configuration" class="position-relative d-flex align-items-center group"> Workspace Configuration <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="workspace-configuration" aria-haspopup="dialog" aria-label="Share link: Workspace Configuration"> Share link </button> </h4>For multi-file projects, configure the workspace root: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- Neovim: Custom root directory detection root_dir = function(fname) return lspconfig.util.root_pattern('.git', 'geode.yaml')(fname) or lspconfig.util.find_git_ancestor(fname) or vim.fn.getcwd() end </code></pre></div> <h4 id="server-logging" class="position-relative d-flex align-items-center group"> Server Logging <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="server-logging" aria-haspopup="dialog" aria-label="Share link: Server Logging"> Share link </button> </h4>Enable detailed logging for debugging: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"># Redirect stderr to log file geode lsp 2> /tmp/geode-lsp.log # Or in IDE configuration { "gql.trace.server": "verbose" } </code></pre></div> <h3 id="troubleshooting" class="position-relative d-flex align-items-center group"> Troubleshooting <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="troubleshooting" aria-haspopup="dialog" aria-label="Share link: Troubleshooting"> Share link </button> </h3> <h4 id="server-not-starting" class="position-relative d-flex align-items-center group"> Server Not Starting <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="server-not-starting" aria-haspopup="dialog" aria-label="Share link: Server Not Starting"> Share link </button> </h4>Symptom: IDE shows “LSP server failed to start” Solutions: <ol> <li> Verify Geode is installed: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">which geode geode --version </code></pre></div></li> <li> Test server manually: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">geode lsp --help </code></pre></div></li> <li> Check permissions: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">ls -la $(which geode) </code></pre></div></li> <li> Review IDE logs for error messages </li> </ol> <h4 id="no-completions-or-hover" class="position-relative d-flex align-items-center group"> No Completions or Hover <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="no-completions-or-hover" aria-haspopup="dialog" aria-label="Share link: No Completions or Hover"> Share link </button> </h4>Symptom: Code completion or hover not working Solutions: <ol> <li> Verify file extension is recognized: <ul> <li>Use <code>.gql</code>, <code>.gcypher</code>, or <code>.cypher</code></li> </ul> </li> <li> Check LSP client is attached: <ul> <li>Neovim: <code>:LspInfo</code></li> <li>VS Code: Check LSP output panel</li> </ul> </li> <li> Verify server capabilities: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- Neovim: Print capabilities :lua print(vim.inspect(vim.lsp.get_active_clients()[1].server_capabilities)) </code></pre></div></li> <li> Restart LSP client: <ul> <li>Neovim: <code>:LspRestart</code></li> <li>VS Code: Reload window</li> </ul> </li> </ol> <h4 id="diagnostics-not-updating" class="position-relative d-flex align-items-center group"> Diagnostics Not Updating <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="diagnostics-not-updating" aria-haspopup="dialog" aria-label="Share link: Diagnostics Not Updating"> Share link </button> </h4>Symptom: Syntax errors not showing or outdated Solutions: <ol> <li> Verify text synchronization mode: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "textDocumentSync": 1 // Full sync mode } </code></pre></div></li> <li> Check document version numbers are incrementing </li> <li> Force document refresh: <ul> <li>Save file (triggers didSave)</li> <li>Close and reopen file</li> </ul> </li> <li> Review LSP server logs for errors </li> </ol> <h4 id="high-cpu-usage" class="position-relative d-flex align-items-center group"> High CPU Usage <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="high-cpu-usage" aria-haspopup="dialog" aria-label="Share link: High CPU Usage"> Share link </button> </h4>Symptom: LSP server consuming excessive CPU Solutions: <ol> <li> Check for very large files (> 10,000 lines) <ul> <li>Parser may be slow on large inputs</li> </ul> </li> <li> Disable unnecessary features: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "gql.diagnostics.enable": false // Disable real-time checking } </code></pre></div></li> <li> Increase debounce time in IDE: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "editor.quickSuggestionsDelay": 500 // VS Code } </code></pre></div></li> </ol> <h4 id="memory-leaks" class="position-relative d-flex align-items-center group"> Memory Leaks <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="memory-leaks" aria-haspopup="dialog" aria-label="Share link: Memory Leaks"> Share link </button> </h4>Symptom: LSP server memory usage growing over time Solutions: <ol> <li> Restart LSP server periodically <ul> <li>Neovim: <code>:LspRestart</code></li> </ul> </li> <li> Close unused documents: <ul> <li>Server maintains state for all open files</li> </ul> </li> <li> Report issue with reproduction steps </li> </ol> <h3 id="future-enhancements" class="position-relative d-flex align-items-center group"> Future Enhancements <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="future-enhancements" aria-haspopup="dialog" aria-label="Share link: Future Enhancements"> Share link </button> </h3> <h4 id="planned-features" class="position-relative d-flex align-items-center group"> Planned Features <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="planned-features" aria-haspopup="dialog" aria-label="Share link: Planned Features"> Share link </button> </h4>Short-term: <ol> <li>Document formatting (pretty-print GQL)</li> <li>Go-to-definition for variables</li> <li>Symbol outline (document structure)</li> <li>Find references</li> </ol> Long-term: <ol> <li>Semantic highlighting (textDocument/semanticTokens)</li> <li>Code actions (quick fixes, refactorings)</li> <li>Signature help for functions</li> <li>Inlay hints for types</li> <li>Call hierarchy</li> <li>Type hierarchy</li> <li>Rename refactoring</li> <li>Workspace symbols</li> </ol> <h3 id="best-practices" class="position-relative d-flex align-items-center group"> Best Practices <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="best-practices" aria-haspopup="dialog" aria-label="Share link: Best Practices"> Share link </button> </h3> <h4 id="file-organization" class="position-relative d-flex align-items-center group"> File Organization <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="file-organization" aria-haspopup="dialog" aria-label="Share link: File Organization"> Share link </button> </h4>Organize GQL files for optimal LSP experience: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-fallback" data-lang="fallback">project/ ├── queries/ │ ├── users.gql │ ├── products.gql │ └── analytics.gql ├── schemas/ │ └── graph_schema.gql └── .git/ </code></pre></div> <h4 id="query-style" class="position-relative d-flex align-items-center group"> Query Style <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="query-style" aria-haspopup="dialog" aria-label="Share link: Query Style"> Share link </button> </h4>Write clear, well-formatted queries: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Good: Clear structure, proper indentation MATCH (u:User)-[:PURCHASED]->(p:Product) WHERE u.country = 'US' AND p.category = 'Electronics' RETURN u.name, p.name, p.price ORDER BY p.price DESC LIMIT 10 // Avoid: Single-line, hard to read MATCH (u:User)-[:PURCHASED]->(p:Product) WHERE u.country='US' AND p.category='Electronics' RETURN u.name,p.name,p.price ORDER BY p.price DESC LIMIT 10 </code></pre></div> <h4 id="leveraging-hover" class="position-relative d-flex align-items-center group"> Leveraging Hover <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="leveraging-hover" aria-haspopup="dialog" aria-label="Share link: Leveraging Hover"> Share link </button> </h4>Use hover documentation to learn GQL: <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-gql" data-lang="gql">// Hover over each keyword to see documentation MATCH (n:Person) WHERE n.age > 25 RETURN count(n) AS total </code></pre></div> <h4 id="completion-workflow" class="position-relative d-flex align-items-center group"> Completion Workflow <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="completion-workflow" aria-haspopup="dialog" aria-label="Share link: Completion Workflow"> Share link </button> </h4>Efficient use of code completion: <ol> <li>Type keyword prefix: <code>MAT</code> → <code>MATCH</code></li> <li>Use trigger characters: <code>n.</code> → property suggestions</li> <li>Function completion: <code>cou</code> → <code>count()</code></li> <li>Parameter names: <code>$</code> → parameter suggestions</li> </ol> <h3 id="integration-examples" class="position-relative d-flex align-items-center group"> Integration Examples <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="integration-examples" aria-haspopup="dialog" aria-label="Share link: Integration Examples"> Share link </button> </h3> <h4 id="vs-code--gql-workflow" class="position-relative d-flex align-items-center group"> VS Code + GQL Workflow <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="vs-code--gql-workflow" aria-haspopup="dialog" aria-label="Share link: VS Code &#43; GQL Workflow"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json">{ "files.associations": { "*.gql": "gql" }, "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll": true }, "gql.server.enable": true, "gql.server.path": "/usr/local/bin/geode", "gql.trace.server": "off" } </code></pre></div> <h4 id="neovim--treesitter--lsp" class="position-relative d-flex align-items-center group"> Neovim + Treesitter + LSP <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="neovim--treesitter--lsp" aria-haspopup="dialog" aria-label="Share link: Neovim &#43; Treesitter &#43; LSP"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-lua" data-lang="lua">-- Complete setup with syntax highlighting and LSP require('nvim-treesitter.configs').setup{ ensure_installed = { "gql" }, highlight = { enable = true }, } require('lspconfig').geode.setup{ on_attach = on_attach, capabilities = capabilities, } </code></pre></div> <h4 id="vim--ale-alternative" class="position-relative d-flex align-items-center group"> Vim + ALE (Alternative) <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="vim--ale-alternative" aria-haspopup="dialog" aria-label="Share link: Vim &#43; ALE (Alternative)"> Share link </button> </h4><div class="highlight"><pre tabindex="0" class="chroma"><code class="language-vim" data-lang="vim">let g:ale_linters = { \ 'gql': ['geode-lsp'], \} let g:ale_fixers = { \ 'gql': ['geode-format'], \} </code></pre></div> <h3 id="editor-plugins" class="position-relative d-flex align-items-center group"> Editor Plugins <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="editor-plugins" aria-haspopup="dialog" aria-label="Share link: Editor Plugins"> Share link </button> </h3> <h4 id="available-plugins" class="position-relative d-flex align-items-center group"> Available Plugins <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="available-plugins" aria-haspopup="dialog" aria-label="Share link: Available Plugins"> Share link </button> </h4>Complete editor integration packages are available: Claude Code Plugin (<code>geode-claude-plugin/</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">claude /plugin install /path/to/geode-claude-plugin </code></pre></div>Features: <ul> <li>Automatic LSP integration for Claude Code</li> <li>MCP tools for direct Geode access</li> <li>File extension mapping for .gql, .gcypher, .cypher, .pgql</li> <li>Auto-installation hooks</li> </ul> VS Code Extension (<code>editors/vscode/</code>): <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash">cd editors/vscode npm install && npm run compile npx vsce package </code></pre></div>Features: <ul> <li>Full syntax highlighting with TextMate grammar</li> <li>LSP integration via vscode-languageclient</li> <li>Configurable settings</li> </ul> Neovim Configuration (<code>editors/neovim/</code>): <ul> <li><code>gql.lua</code> - nvim-lspconfig setup with key mappings</li> <li><code>gql.vim</code> - Vim-style syntax highlighting</li> </ul> See <code>editors/README.md</code> for complete setup instructions. <h3 id="next-steps" class="position-relative d-flex align-items-center group"> Next Steps <button type="button" class="h-share btn btn-link p-0 text-decoration-none link-secondary opacity-50 hover-opacity-100 transition-all ms-1" data-share-target="next-steps" aria-haspopup="dialog" aria-label="Share link: Next Steps"> Share link </button> </h3>Explore More: <ul> <li><a href="/docs/development/repl-advanced/" >REPL Advanced Features</a> - Interactive shell</li> <li><a href="/docs/guides/testing-strategies/" >Testing Strategies</a> - Test your queries</li> <li><a href="/docs/query/performance-tuning/" >Query Performance Tuning</a> - Optimize queries</li> </ul> Related Topics: <ul> <li><a href="/docs/gql/guide/" >GQL Guide</a> - Learn GQL syntax</li> <li><a href="/docs/reference/api-reference-complete/" >API Reference</a> - Complete function list</li> <li><a href="/docs/guides/schema-design/" >Schema Design</a> - Graph modeling</li> </ul> Community: <ul> <li>Report LSP issues on <a href="https://gitlab.com/devnw/codepros/geode" aria-label="GitLab – opens in new window" target="_blank" rel="noopener noreferrer" >GitLab ↗ </a> </li> <li>Request features in discussions</li> <li>Contribute editor plugins</li> </ul> <hr> Implementation: Complete (79/79 tests passing) Protocol: LSP 3.17, JSON-RPC 2.0 Parser: ISO/IEC 39075:2024 compliance Status: Production-ready