sn-docs

# sn-docs CLI and MCP server for querying [docs.servicenow.com](https://www.servicenow.com/docs/) via the ServiceNow Fluid Docs API. Enables Claude and other AI tools to search and retrieve official ServiceNow documentation at runtime — no authentication required. ## Requirements - Node.js 20+ ## Installation ### Option A: Download a release Three files available from the [latest release](../../releases/latest): | File | Use | |---|---| | `sn-docs-cli.cjs` | Standalone CLI — requires Node.js 20+ | | `sn-docs-mcp.cjs` | MCP server for Claude Code / Claude Desktop — requires Node.js 20+ | ```bash # CLI node sn-docs-cli.cjs search "incident management" --limit 5 # MCP server (reference in your MCP config, see below) node sn-docs-mcp.cjs ``` ### Option B: Clone and build ```bash git clone https://github.com/wiz0floyd/sn-docs.git cd sn-docs npm install npm run build node bin/sn-docs.js --help ``` ## CLI Usage ``` sn-docs search <query> Search documentation sn-docs get <url> Fetch article as Markdown sn-docs suggest <input> Get autocomplete suggestions sn-docs locales List available languages ``` ### Options | Flag | Commands | Default | Description | |---|---|---|---| | `-l, --lang` | search, get | `en-US` | Language code | | `-v, --release-version` | search | `current` | Release version: `current` (default), a release name (e.g. `zurich`), or `any` for all releases | | `-n, --limit` | search | `10` | Results per page | | `-p, --page` | search | `1` | Page number | | `--json` | search | — | Raw JSON output | ### Examples ```bash # Search with limit sn-docs search "flow designer" --limit 5 # Search in German (run "sn-docs locales" to see all available language codes) sn-docs search "incident management" --lang de-DE # Search a specific release sn-docs search "flow designer" --release-version zurich # Search across all releases sn-docs search "incident" --release-version any # Fetch article as Markdown (use contentUrl from search results) sn-docs get "https://www.servicenow.com/docs/api/khub/maps/abc/topics/xyz/content" # Get suggestions while typing sn-docs suggest "flow des" # List available languages sn-docs locales ``` ### Release versions The `--release-version` flag accepts: - `current` (default) — docs not pinned to a specific release - `any` — all releases combined - A release name: `fuji`, `geneva`, `helsinki`, `istanbul`, `jakarta`, `kingston`, `london`, `madrid`, `newyork`, `orlando`, `paris`, `quebec`, `rome`, `sandiego`, `tokyo`, `utah`, `vancouver`, `washingtondc`, `xanadu`, `yokohama`, `zurich`, `australia`, `brazil` ### Search output ``` Found 42,830 results (page 1 of 4283) ## Flow Designer overview Now Platform > Application Development > Flow Designer Flow Designer is a Now Platform® feature for automating business logic... https://www.servicenow.com/docs/r/platform-app-dev/flow-designer-overview.html Updated: 2026-03-01 ``` ## MCP Server (Claude integration) The MCP server exposes 4 tools to Claude: | Tool | Description | |---|---| | `search_docs` | Search with query, lang, limit, page | | `get_article` | Fetch article as Markdown by URL | | `suggest` | Autocomplete suggestions | | `list_locales` | Available languages | ### Register with Claude Code Add to `~/.claude/settings.json`: ```json { "mcpServers": { "sn-docs": { "command": "node", "args": ["/path/to/sn-docs-mcp.mjs"] } } } ``` ### Register with Claude Desktop Add to your Claude Desktop config: ```json { "mcpServers": { "sn-docs": { "command": "node", "args": ["/path/to/sn-docs-mcp.mjs"] } } } ``` Replace `/path/to/sn-docs-mcp.cjs` with the absolute path to the downloaded file or `dist/mcp-server.js` if building from source. ## Cloudflare MCP (Claude.ai) A Cloudflare Worker hosts the same MCP tools over HTTP, making them available to Claude.ai without a local Node.js process. Claude.ai cannot POST directly to the Fluid Docs API, so the worker acts as the intermediary. Deploy your own worker (see below) to get an endpoint URL, then: ### Add to Claude.ai In Claude.ai → Settings → Integrations → Add MCP Server, enter your worker URL. ### Add to Claude Code ```json { "mcpServers": { "sn-docs": { "type": "http", "url": "https://<your-worker>.workers.dev/mcp" } } } ``` The worker exposes the same four tools (`search_docs`, `get_article`, `suggest`, `list_locales`) and applies a rate limit of 60 requests per minute per IP. ### Self-host ```bash npm run build npm run build:worker npx wrangler deploy ``` See the [Wrangler deploy documentation](https://developers.cloudflare.com/workers/wrangler/commands/#deploy) for configuration options. ## Development ```bash npm install npm test # Unit tests (mocked, no network) npm run test:integration # Live API smoke tests npm run build # Compile TypeScript → dist/ npm run lint # Type-check ``` See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines. ## License [MIT](LICENSE)