Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

84 lines (65 loc) · 2.33 KB

Contributing to QGIS MCP

Thank you for your interest in contributing! 🎉
This project connects QGIS to Claude AI through the Model Context Protocol (MCP)). Your help in improving this integration is very welcome.

Getting Started

  1. Fork the Repository
    Clone your fork locally:

    git clone git@github.com:YOUR-USERNAME/qgis_mcp.git
cd qgis_mcp

  2. Install Prerequisites

    • QGIS 3.X (tested on 3.22)
    • Python 3.10 or newer
    • uv package manager
    • Claude desktop

    On Mac:

    brew install uv

    On Windows Powershell:

    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

  3. Set Up the QGIS Plugin
    Create a symlink from this repo’s qgis_mcp_plugin folder to your QGIS profile plugin directory.

    On Mac:

    ln -s $(pwd)/qgis_mcp_plugin ~/Library/Application\ Support/QGIS/QGIS3/profiles/default/python/plugins/qgis_mcp

    On Windows Powershell:

    $src = "$(pwd)\qgis_mcp_plugin"
$dst = "$env:APPDATA\QGIS\QGIS3\profiles\default\python\plugins\qgis_mcp"
New-Item -ItemType SymbolicLink -Path $dst -Target $src

    Restart QGIS, go to Plugins > Manage and Install Plugins, search for QGIS MCP, and enable it.

  4. Configure Claude Desktop
    Add the server configuration to claude_desktop_config.json:

    {
  "mcpServers": {
    "qgis": {
      "command": "uv",
      "args": [
        "--directory",
        "/ABSOLUTE/PATH/TO/qgis_mcp/src/qgis_mcp",
        "run",
        "qgis_mcp_server.py"
      ]
    }
  }
}

Development Workflow

  • Start the QGIS plugin (Plugins > QGIS MCP > Start Server).
  • Run the MCP server via Claude Desktop integration.
  • Make your changes and test locally.

Contributing Guidelines

  • Keep PRs focused on a single change.
  • Write clear commit messages.
  • Update docs if behavior changes.
  • Be cautious when using execute_code (it runs arbitrary PyQGIS).

Reporting Issues

  • Use GitHub Issues.
  • Include OS, QGIS version, and error logs where relevant.