Tools

Every rs3dev command and every tool, prompt and resource of the rs3-plugin-mcp MCP server. These pages are generated from the CLI's own help output and from mcp-tools.json at build time.

rs3dev commands

• rs3dev init [options] <name>
  scaffold a new plugin folder named <name> in the current directory
• rs3dev adopt [options] [path]
  bring an existing plugin folder into the toolkit: .luarc.json plus AGENTS.md, Cursor rules and Claude Code skills; plugin.json and main.lua are never touched
• rs3dev luarc [options] [path]
  write or refresh .luarc.json for a plugin folder and print which stubs location was used
• rs3dev validate [options] [path]
  check plugin.json against the schema and the plugin folder structure
• rs3dev preflight [options] [path]
  static checks for sandbox, permission, lifecycle and readability problems; exits 1 on errors
• rs3dev sync [options] [path]
  copy the plugin into the client's dev_plugins folder and print the reload command
• rs3dev watch [options] [path]
  sync on every save, debounced; press Ctrl+C to stop
• rs3dev doctor [options] [path]
  report the client folder, stubs, LuaLS binary, .luarc.json and docs cache; exits 1 when something is missing
• rs3dev test [options] [path]
  run the plugin's Lua tests (tests/*.lua or spec/*.lua) outside the client against API fakes generated from the stubs; exits 1 on failure
• rs3dev stubs [options] <action>
  'status' checks whether the installed stubs still match the documentation (one conditional request)
• rs3dev cache <action>
  manage the documentation cache: 'path' prints its location, 'clear' removes it
• rs3dev package [options] [path]
  build the zip for manual upload to mod.io

MCP tools

• docs_searchdocs
  Search API symbols, page titles and, once docs_index has run, full page sections by words, returning signatures and docs URLs.
• docs_getdocs
  Fetch a developer.runescape.com page live with a local ETag cache and return its text or one section.
• docs_indexdocs
  Build the per-user full-text index of the documentation pages so docs_search can answer intent queries.
• api_lookupdocs
  Return the LuaLS signature, stub file and docs URL for an API symbol.
• manifest_validateplugin
  Validate a plugin folder's plugin.json against the schema and check the folder structure.
• guidelines_preflightplugin
  Run static sandbox, permission, lifecycle and readability checks and link each finding to the docs.
• plugin_scaffoldplugin
  Create a new plugin folder inside the workspace without overwriting existing files.
• devplugins_syncclient
  Copy a plugin into the client's dev_plugins root, replacing the previous copy. Requires confirm=true; dry_run lists the files.
• package_zipplugin
  Run preflight and build the mod.io zip inside the workspace dist folder.

MCP prompts

• new_plugin
  Scaffold a plugin, gate its permissions and leave it validated and preflighted.
• fix_preflight
  Run guidelines_preflight on a plugin and fix every finding using its docs link.
• prepare_submission
  Walk the submission checklist and build the zip for the manual mod.io upload.

MCP resources

• rs3://stubs/index.json
  The stubs symbol index served by api_lookup.
• rs3://stubs/unresolved.md
  The generator's report of inferred and unresolved API surface.
• rs3://stubs/modules/{+id}
  The LuaLS stub file for one documentation page, id being the page path without extension.

Install: npm install -g @tmhs/rs3-devtools-cli; MCP configuration examples are in packages/mcp/examples.