Add the docs MCP server to your coding assistant

After this guide, your coding assistant can search and read this documentation through the MCP server at https://docs.heylua.ai/mcp, so answers about lua-cli come from the published pages rather than from training data. The server is read-only and needs no account. In Claude Code, the plugin registers it for you. Verified against lua-cli 3.33.0. The server exposes three tools.

Tool	What it does
`search_lua_cli`	Semantic search across the docs; returns matching passages with page titles and links
`query_docs_filesystem_lua_cli`	Runs one read-only shell command (`tree`, `ls`, `rg`, `grep`, `find`, `head`, `cat`, `jq`, and similar) against an in-memory filesystem that holds every page as `/<path>.mdx`; each call is stateless
`submit_feedback`	Reports a page that is wrong, outdated, confusing, or incomplete to the docs team

Before you begin

A client that supports MCP over HTTP: Claude Code, claude.ai or the Claude desktop app, Cursor, or Windsurf. For a client that only supports stdio, see Options you may need.

Add the server

Claude Code
Claude
Cursor
Windsurf

Add it for the current project, or add --scope user to make it available in every project.

claude mcp add --transport http lua-docs https://docs.heylua.ai/mcp

In claude.ai or the Claude desktop app, select Customize, then Connectors, select + and Add custom connector, enter https://docs.heylua.ai/mcp, and select Add; the server needs no sign-in, so leave the OAuth fields empty. On Team and Enterprise plans an owner adds it under Organization settings; the Free plan allows one custom connector.

Add the server to .cursor/mcp.json in the project, or to ~/.cursor/mcp.json for every project.

.cursor/mcp.json

{
  "mcpServers": {
    "lua-docs": {
      "url": "https://docs.heylua.ai/mcp"
    }
  }
}

Add the server to ~/.codeium/windsurf/mcp_config.json.

~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "lua-docs": {
      "serverUrl": "https://docs.heylua.ai/mcp"
    }
  }
}

Verify

Ask a question only the docs can answer and check which tool the assistant calls.

What input does `lua test webhook` expect, and what does exit code 9 mean?

In Claude Code, /mcp lists lua-docs as connected with three tools, and the answer cites results from search_lua_cli or query_docs_filesystem_lua_cli. An assistant that uses the server well searches first, reads a page with head -80 /<path>.mdx, and uses rg -il "<term>" / for exact identifiers.

Options you may need

Read the docs without MCP

The site publishes plain-text indexes any tool can fetch: https://docs.heylua.ai/llms.txt lists every page with a one-line description, https://docs.heylua.ai/llms-full.txt holds the full text of every page in one file, and any page is available as Markdown when you append .md to its URL.

Clients that only support stdio

Bridge the HTTP server with mcp-remote in any client that accepts a command-based server definition.

{
  "mcpServers": {
    "lua-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://docs.heylua.ai/mcp"]
    }
  }
}

If it isn’t working

Claude Code doesn't list lua-docs

claude mcp list shows every configured server with its connection status. A server added with the default --scope local loads only in the project where you added it; add it again with --scope user, or open /mcp to read the connection error.

The server is listed but the assistant never calls it

Ask a question that names a Lua identifier, such as LuaJob or lua version promote; a generic question may be answered from memory. In Cursor and Windsurf, restart the editor if the server doesn’t appear after you edit the config file.

Next steps

Build with a coding assistant

The exports, commands, exit codes, and compile rules to give the assistant.

Build with the Claude Code plugin

Slash commands and a production gate on top of the same CLI and this server.

SDK reference

One page per export, the pages the assistant reads most.

CLI reference

Every command, flag, and exit code.

Get started

Concepts

Build

Channels

Integrations

Devices

Ship and operate

Marketplace

Build with AI

Examples

Add the docs MCP server to your coding assistant

Options you may need

Read the docs without MCP

Clients that only support stdio

If it isn’t working

Next steps

Build with a coding assistant

Build with the Claude Code plugin

SDK reference

CLI reference

​Options you may need

​Read the docs without MCP

​Clients that only support stdio

​If it isn’t working

​Next steps

Build with a coding assistant

Build with the Claude Code plugin

SDK reference

CLI reference

Options you may need

Read the docs without MCP

Clients that only support stdio

If it isn’t working

Next steps