Gamemaker

You can access GameMaker documentation programmatically through a dedicated MCP server that exposes fast lookup, search, and file retrieval capabilities. It enables you to integrate GameMaker docs into your tools and editors, automate documentation workflows, and quickly access function definitions and categories from your own environment.

How to use

You use the MCP server by launching it in your environment and connecting an MCP client to it. The server exposes five core tools that let you look up specific GML functions, search documentation content, list functions by pattern or category, retrieve specific documentation files, and initialize with a wide-ranging GML coding guide. To begin, run the MCP server or connect through a client that supports the MCP protocol, and then use the client to invoke the available tools to perform lookups, searches, or file fetches.

How to install

Prerequisites: ensure you have Node.js installed and available in your development environment. You will also need npm to manage packages.

Recommended quick start (no local installation required): use the command runner to start the MCP server and the accompanying CLI tools directly via npx.

# Start MCP server
npx @petah/gamemaker-mcp

# Start CLI tool helper
npx @petah/gamemaker-mcp gm-cli --help

# Alternative command names
npx @petah/gamemaker-mcp gamemaker-mcp  # MCP server
npx @petah/gamemaker-mcp gm-docs lookup draw_sprite  # CLI tool

Additional installation options

Global installation is also supported if you prefer binaries available on your system path.

# Install globally
npm install -g @petah/gamemaker-mcp

# Then use directly
gamemaker-mcp
gm-cli --help
gm-docs lookup draw_sprite

Local development workflow

If you are developing locally, clone the project, install dependencies, and run the MCP server or CLI in development mode.

# Clone the repository
git clone <repository-url>
cd gm-mcp

# Install dependencies
npm install

# Run the MCP server in development mode (example commands shown in the source) 
npm run mcp
node src/gamemaker-docs-server.js

Available tools

lookup_gamemaker_function

Look up a specific GML function, returning its definition and usage details.

search_gamemaker_docs

Search the documentation content for a given query and present relevant results.

list_gamemaker_functions

List functions by a pattern or category to help you explore related APIs.

get_gamemaker_file

Retrieve a specific documentation file, such as a Markdown or HTML page, by path.

init_gamemaker_agent

Initialize with a comprehensive GML coding guide to tailor the documentation experience.