Skip to content

docs: add Grok Build quickstart - #1517

Draft
claude[bot] wants to merge 1 commit into
mainfrom
docs/grok-build-quickstart
Draft

claude[bot] wants to merge 1 commit into
mainfrom
docs/grok-build-quickstart

Conversation

@claude

@claude claude Bot commented Oct 3, 2026

Copy link
Copy Markdown
Contributor

Requested by Micah Stairs · Slack thread

Before: Grok Build has no docs page. The Firecrawl dashboard install flow lists Grok Build with Remote MCP and Local MCP options. The docs mention Grok and xAI only in billing.mdx, for X (x.com) requests.

After: quickstarts/grok-build.mdx documents Grok Build setup. The page shows hosted OAuth MCP first and local MCP with an API key second. The page is in the English "Agent Harnesses" nav after Codex CLI. integrations.mdx and the ai-onboarding.mdx "Agent Harnesses" grid have a Grok Build card.

How: The page uses the structure of quickstarts/claude-code.mdx and quickstarts/codex-cli.mdx.

  • Remote: grok mcp add --transport http firecrawl https://mcp.firecrawl.dev/v2/mcp-oauth. Then enter /mcps, select firecrawl, and press i to sign in. This is the same as the dashboard (firecrawl-web lib/mcp/hosted-mcp-install.ts, main 086dc6e).
  • Local: a ~/.grok/config.toml block that runs npx -y firecrawl-mcp@3.23.7 with FIRECRAWL_API_KEY = "${FIRECRAWL_API_KEY}". Grok expands the reference at load time, so the key does not go into the file.

I checked the syntax against the xAI docs: MCP Servers and Grok Build overview. The -e/-H flags of grok mcp add are in the Grok Build changelog (0.2.51).

Notes for review:

  • The dashboard and xAI docs agree on the remote command and on /mcps then i. There is one difference in the local form. The dashboard uses grok mcp add firecrawl -e FIRECRAWL_API_KEY=<key> -- npx -y firecrawl-mcp@3. This page uses the config.toml block from the xAI docs instead. The repo checks forbid -e FIRECRAWL_API_KEY= in the Claude Code quickstart, and the peer quickstarts keep raw keys out of commands. The xAI docs do not say if -e values expand ${VAR}. The page also pins the reviewed firecrawl-mcp@3.23.7, not the dashboard's @3.
  • I did not add the Firecrawl CLI route (firecrawl-cli init / launch). The dashboard's FIRECRAWL_LAUNCH_TARGETS does not include Grok, and no CLI page lists Grok as an agent.
  • No Grok logo is in images/. The cards use the Mintlify built-in terminal icon, so this PR adds no binaries.
  • English only. CLAUDE.md says to not edit localized files, and the translation pipeline creates locale pages and nav. No peer quickstart was added to locale directories by hand.
  • scripts/check-hosted-mcp-docs.sh: I added grok-build to the keyless-link loop and the pinned-version list. I also added a require for the OAuth command and a forbid for -e FIRECRAWL_API_KEY=.

Validation:

  • docs.json is valid JSON (python3 -m json.tool).
  • sh scripts/check-extraction-hostile-markdown.sh passes.
  • sh scripts/check-locale-api-literals-selftest.sh passes.
  • sh scripts/check-locale-api-literals.sh fails on main too (pt-BR rastreioDeMudan, dadosRaspados). This PR does not cause it.
  • sh scripts/check-hosted-mcp-docs.sh fails on main too (mcp-server.mdx / keyless.mdx strings and locale MCP nav groups). With the failing require exits disabled, the branch and main give the same 9 failures. The new Grok lines pass, and they fail when I break the command in the page.
  • npx mint broken-links and npx mint validate give the same output on the branch and on main. The 12 warnings are missing snippets/v2/extract imports, and no warning is about the new page.

🤖 Generated with Claude Code

https://claude.ai/code/session_01FjogPMdSS8baEL7icbirG5


Generated by Claude Code

Add quickstarts/grok-build.mdx for the xAI Grok Build CLI. The page
shows hosted OAuth MCP setup first and local MCP with an API key second.
Add the page to the English Agent Harnesses nav. Add Grok Build cards to
integrations.mdx and ai-onboarding.mdx. Add the page to the hosted MCP
truth checks.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FjogPMdSS8baEL7icbirG5
@mintlify

mintlify Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
firecrawl 🟢 Ready View Preview Oct 3, 2026, 5:45 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@claude

claude Bot commented Oct 3, 2026

Copy link
Copy Markdown
Contributor Author

The check Locale literals and extraction-hostile markdown fails on this PR. The cause is not in this PR.

What fails

The step Keep API literals untranslated (scripts/check-locale-api-literals.sh) fails. It names 14 lines in these files:

  • es/features/change-tracking.mdx, es/features/fast-scraping.mdx, es/features/search.mdx, es/sdks/cli.mdx, es/v1/features/search.mdx (seguimientoDeCambios)
  • es/webhooks/events.mdx (rastreo.iniciado)
  • fr/features/change-tracking.mdx, fr/features/monitoring.mdx, fr/sdks/cli.mdx, fr/v1/features/search.mdx (suiviDesModifications)
  • pt-BR/features/change-tracking.mdx, pt-BR/sdks/cli.mdx, pt-BR/v1/features/search.mdx (rastreioDeMudan)
  • pt-BR/v0/sdks/node.mdx (dadosRaspados)

This PR does not touch these files. It changes only quickstarts/grok-build.mdx, docs.json, integrations.mdx, ai-onboarding.mdx and scripts/check-hosted-mcp-docs.sh.

The two later steps did not run, because the first step failed. I ran them locally on this branch. Both pass (check-locale-api-literals-selftest.sh and check-extraction-hostile-markdown.sh).

Main has the same failure

This workflow runs only on pull_request, so main has no run of its own. The translations came from #1515, which merged with this check red (run 37082811455). A local run of the script on main (8b3d280) gives the same 14 lines. #1516 fails the same way (run 37125733120).

Fix

No dedicated fix PR exists. #1514 changes these locale files and adds dadosRaspados to the script allowlist, but it is a larger feature PR and it has merge conflicts. A small fix PR that does only this work would unblock all open docs PRs.


Generated by Claude Code

This branch was successfully deployed

1 active deployment
staging — 24bbd8b1 Deployed Oct 3, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant