Skip to content
grandocs

Using these docs with GitHub Copilot (VS Code)

View .md Open in ChatGPT Open in Claude

VS Code is where most grandMA3 Lua plugin authors already work. Wiring grandocs into Copilot means it can look up real API functions and command syntax instead of inventing them.

Connect the MCP server (agent mode)

Section titled “Connect the MCP server (agent mode)”

  1. Create .vscode/mcp.json in your workspace:

    {
      "servers": {
        "grandocs": { "type": "http", "url": "https://grandocs-mcp.samcarlton.workers.dev/mcp" }
      }
    }

    (Or run MCP: Add Server from the Command Palette and paste the URL.)

  2. Open Copilot Chat and switch to Agent mode — the grandocs tools (search_docs, command_lookup, get_page) become available.

  3. Ask in context, e.g. “Look up the grandMA3 Lua function for setting a property and write a plugin that…”.

Full tool list and other clients: Any MCP client.

Or add the docs as plain context

Section titled “Or add the docs as plain context”

No MCP needed — Copilot can read files and links you give it:

  • A docs file in your repo. Save a product set such as /_llms-txt/grandma3-v24.txt into your project and #-reference it in Copilot Chat.
  • A copilot-instructions.md (.github/copilot-instructions.md) that tells Copilot: “For grandMA3 Lua/command questions, use the grandocs manual; quote syntax verbatim; never invent API functions.”
  • A single page — paste a .md twin URL or use Copy as Markdown.