Roblox Creator Docs

Typed scraper and MCP server for the Roblox Creator Hub API Reference and Guides.

npm version license node

Provides MCP-compatible AI assistants with structured access to Roblox API + Creator Hub guides.

---

MCP Setup

{
  "mcpServers": {
    "rodocs": {
      "command": "npx",
      "args": ["-y", "rodocsmcp", "--stdio"]
    }
  }
}

If you need higher GitHub API limits or access to authenticated raw/content fetches, pass a GitHub PAT with --github-token or expose it through GITHUB_TOKEN.

{
  "mcpServers": {
    "rodocs": {
      "command": "npx",
      "args": ["-y", "rodocsmcp", "--stdio", "--github-token", "YOUR_GITHUB_PAT"]
    }
  }
}

---

MCP Tools

Tool	Description
get_api_reference	Fetch API entry
get_many_api_references	Batch fetch (max 20)
list_api_names	List classes/enums
find_api_name	Resolve closest API name
search_guides	Search Creator Guides
get_guide	Fetch guide content
list_guides	List available guides
get_code_samples	Fetch code samples only
compare_api_members	Compare topic members
get_api_changelog	Inspect deprecations

---

CLI

Usage

npx rodocsmcp TweenService
npx rodocsmcp --list
npx rodocsmcp --find tweenserv
npx rodocsmcp --search-guide "data store"
npx rodocsmcp --guide scripting/data/data-stores.md
npx rodocsmcp --github-token "$GITHUB_TOKEN" TweenService
npx rodocsmcp --stdio

Commands

Command	Description
<topic>	Show API docs
--list	List API names
--find <query>	Resolve API name
--search-guide <query>	Search guides
--guide <path>	Fetch guide
--github-token <token>	Authenticate GitHub requests
--stdio	Start MCP server

Authentication

GitHub-backed fetches accept either:

• the --github-token <token> CLI flag
• the GITHUB_TOKEN environment variable

The explicit CLI flag takes precedence over GITHUB_TOKEN.

---

Programmatic API

import {
  scrapeTopic,
  scrapeMany,
  scrapeIndex,
  findClosestApiName,
} from "rodocsmcp";

await scrapeTopic("Actor");
await scrapeMany(["Vector3", "CFrame"]);
await scrapeIndex();
await findClosestApiName("tweenserv");

---

Build from Source

Requirements: Node.js >= 20.10.0, pnpm >= 10

git clone https://github.com/iamthebestts/RoDocs-MCP
cd RoDocs-MCP
pnpm install

Development

pnpm dev

Build

pnpm build

Run built CLI

node dist/cli.js TweenService
node dist/cli.js --stdio

Quality

pnpm typecheck
pnpm check
pnpm test

---

How it works

• API Reference: Extracted from __NEXT_DATA__ on Creator Hub (no DOM scraping)
• Guides: Fetched and indexed from Creator Hub docs
• Search: BM25 ranking with alias normalization and Luau synonym resolution
• Cache: In-memory TTL (10 min)

---

Contributing

See CONTRIBUTING.md.

License

MIT