Skip to main content

MCP server providing 15 AI-optimized tools for GDScript code analysis via Godot's built-in LSP

Project description

GodotLens: AI-First Code Analysis for GDScript

GitHub Release npm PyPI License: MIT

An MCP server providing 15 semantic analysis tools for GDScript, powered by Godot's built-in Language Server.

Built for AI Agents

AI coding agents work with text files but lack semantic understanding of GDScript. When an agent uses grep to find usages of a function, it cannot distinguish a function call from a comment containing the same name, a signal declaration from a signal emission, or an overridden method from an unrelated function.

GodotLens bridges this gap by exposing Godot's built-in Language Server through the Model Context Protocol (MCP), giving AI agents compiler-accurate code intelligence for GDScript — go to definition, find references, diagnostics, rename, and more.

Example: Finding all usages of _on_player_hit:

Approach Result
grep "_on_player_hit" 12 matches including comments, strings, and similarly named functions
gdscript_references Exactly 4 call sites where _on_player_hit is invoked

Prerequisites

  • Godot 4.x editor must be running with your project open — Godot's LSP server starts automatically when the editor opens a project
  • Python 3.10+ (for pip install) or Node.js 16+ (for npx)

Quick Start

Option A: npx (recommended for MCP clients)

Add to your MCP configuration (e.g., .mcp.json for Claude Code):

{
  "mcpServers": {
    "godotlens": {
      "command": "npx",
      "args": ["-y", "godotlens-mcp"]
    }
  }
}

The npm package bundles the full server (~20 KB of Python). Zero external Python dependencies.

Option B: pip

pip install godotlens-mcp
{
  "mcpServers": {
    "godotlens": {
      "command": "godotlens-mcp"
    }
  }
}

Configuration

Environment Variable Default Description
GODOT_LSP_HOST 127.0.0.1 Godot LSP server host
GODOT_LSP_PORT 6005 Godot LSP server port

Tools

Health

Tool Description
gdscript_status Check if Godot LSP is connected

Navigation (6 tools)

Tool Description
gdscript_definition Go to definition of a symbol
gdscript_declaration Go to declaration of a symbol
gdscript_references Find all references to a symbol
gdscript_hover Get hover information (type, docs) for a symbol
gdscript_symbols List all symbols in a file
gdscript_signature_help Get function signature at call site

Refactoring

Tool Description
gdscript_rename Rename a symbol across all files

Synchronization (3 tools)

Tool Description
gdscript_sync_file Notify LSP that a file changed, returns diagnostics
gdscript_sync_files Batch sync multiple files
gdscript_delete_file Notify LSP that a file was deleted

Batch Operations (3 tools)

Tool Description
gdscript_symbols_batch Get symbols from multiple files
gdscript_definitions_batch Get definitions for multiple positions
gdscript_references_batch Find references for multiple positions

Diagnostics

Tool Description
gdscript_diagnostics Get errors/warnings for files

Architecture

┌──────────────┐         ┌────────────────────┐         ┌───────────────────┐
│   AI Agent   │  stdio  │  GodotLens (MCP)   │   TCP   │  Godot Editor     │
│ (Claude, etc)├────────►│  JSON-RPC 2.0      ├────────►│  Built-in LSP     │
│              │◄────────┤  Python 3.10+      │◄────────┤  Port 6005        │
└──────────────┘         └────────────────────┘         └───────────────────┘

GodotLens acts as a bridge between the AI agent and Godot's built-in Language Server. The AI agent communicates with GodotLens via MCP (JSON-RPC over stdio). GodotLens translates MCP tool calls into LSP requests and sends them to the Godot editor over TCP. Responses are compacted for efficient AI consumption.

Zero dependencies — the server uses only the Python standard library. The MCP and LSP protocols are implemented directly, keeping the server lightweight and self-contained.

Important: File Synchronization

Godot's LSP does not automatically detect file changes made outside the editor. When the AI agent modifies a .gd file, it should call gdscript_sync_file or gdscript_sync_files so the LSP re-analyzes the changed code. Without this, diagnostics and navigation results may be stale.

Recommended workflow:

  1. Use GodotLens tools to analyze code
  2. Write changes to files
  3. Call gdscript_sync_file to refresh LSP state
  4. Use GodotLens tools to verify changes

Coordinate System

All line and character parameters are 0-indexed, matching the LSP specification:

  • Line 0, Character 0 = first character of the file

License

MIT License — see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

godotlens_mcp-1.0.1.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

godotlens_mcp-1.0.1-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file godotlens_mcp-1.0.1.tar.gz.

File metadata

  • Download URL: godotlens_mcp-1.0.1.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for godotlens_mcp-1.0.1.tar.gz
Algorithm Hash digest
SHA256 0592eb765e074cf73d1d82aa6282ec3c41c31344d41ed067ec6ec8b0458ea260
MD5 f26104d79828b14525653a88c3724e0c
BLAKE2b-256 7380eeb33f6d3106051d6c5b3134e73ce3175081db9bab042eaf5c036a87eec1

See more details on using hashes here.

File details

Details for the file godotlens_mcp-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: godotlens_mcp-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for godotlens_mcp-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1e9643157f5626c9c66e6e30d070a9e75fe25c108ee132ba8318c8669841ac4
MD5 daf0bf9ed0d281fee4ece69a91426579
BLAKE2b-256 2c7a671da5f924d988aa67ba2c2c7b495cb8678747e5b9751c99812b4ae33b93

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page