MCP GLua Docs

A Model Context Protocol (MCP) server that provides searchable access to Garry's Mod Lua API documentation.

Features

• Search through Garry's Mod Lua API documentation
• Fuzzy search for functions, hooks, libraries, and classes
• Get detailed information about Lua functions, parameters, and return values
• Access to the latest GLua API snippets

Installation

npm install mcp-glua-docs

Usage

To use this MCP server, you need to configure it in your MCP client configuration.

Configuration

Add this to your MCP client configuration (usually in ~/.config/claude/claude_desktop_config.json):

{
  "mcpServers": {
    "glua-docs": {
      "command": "node",
      "args": ["path/to/node_modules/mcp-glua-docs/dist/index.js"]
    }
  }
}

The server will automatically fetch the latest GLua API documentation on first startup.

Available Tools

search_documentation

Search the Garry's Mod Lua API documentation.

• query: Search query string (string, required)

Examples:

• "player.GetAll" - Find the player.GetAll function
• "hook.Add" - Find hook information
• "Vector" - Find Vector class documentation
• "surface.PlaySound" - Find surface library functions

Data Source

This MCP server automatically fetches and uses the latest GLua API documentation from: https://github.com/luttje/glua-api-snippets

The documentation is downloaded and cached locally on first startup, ensuring you always have access to the most up-to-date API information.

Development

# Install dependencies
npm install

# Build
npm run build

# Test
npm test

License

ISC