Skip to content

Repository files navigation

BaseHub

Reference for agents on Base. Every documentation page is reachable as raw Markdown by appending .md to its URL, plus dedicated endpoints for AI agent ingestion.

Live at basehub.org.

BaseHub is an open source, independent community reference for agents. Not affiliated with or endorsed by Coinbase or any related entity.

Agent endpoints

  • /llms.txt — page index in the llms.txt format
  • /llms-full.txt — the full Markdown corpus in a single file
  • /api/pages.json — JSON manifest of every page, plus the URLs of the agent feeds and mirrors
  • /feeds/blog.xml — build-time mirror of the Base engineering blog RSS
  • /feeds/status.xml — build-time mirror of the Base statuspage RSS
  • <page>.md — raw Markdown for any individual page (e.g. /api-reference/eth/eth_blocknumber.md)

MCP server

The @wbnns/base-mcp package exposes BaseHub to Claude Desktop, Cursor, and other stdio MCP clients via two tools (search_basehub_docs, get_basehub_page).

{
  "mcpServers": {
    "basehub": {
      "command": "npx",
      "args": ["-y", "@wbnns/base-mcp"]
    }
  }
}

See mcp/README.md for details.

Local development

Requires Node 20+.

npm install
npm run dev      # http://localhost:4321
npm run build    # production build to dist/

Architecture

  • Astro + Starlight static site, deployed to GitHub Pages
  • 178 docs pages under src/content/docs/, organized into 13 sections
  • Generated endpoints live as Astro routes in src/pages/ (the .txt, .json, and .xml files)
  • Deployed via .github/workflows/deploy.yml on every push to main, plus a daily cron at 00:00 UTC so the mirrored RSS feeds stay fresh

Upstream sync

The .github/workflows/sync-upstream.yml workflow runs daily at 09:17 UTC and snapshots four upstream sources:

It diffs against the committed .upstream-state/last-sync.txt and opens a PR on chore/upstream-sync listing the changed entries along with the BaseHub pages that reference them (via each page's sources: frontmatter array). A maintainer reviews and edits the affected pages.

License

MIT

About

Reference for agents using Base, an L2 from Coinbase built on top of Ethereum

Topics

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Used by

Contributors

Languages