pmndrs docs

io.github.pmndrsv4.15.0更新於 Oct 2, 2026

Search and read the docs and examples of react-three-fiber, drei, zustand, jotai... from your agent

已驗證Streamable HTTP可網頁執行Developer Tools Web Search & Scraping Knowledge & Memory

概覽

AI 產生的概覽

讓助理搜尋並閱讀 react-three-fiber、drei、zustand、jotai 等 pmndrs 函式庫的文件與範例。

功能: 此伺服器發佈一份可搜尋的 pmndrs 文件索引並提供給代理，讓助理能查找 react-three-fiber、drei、zustand、jotai 等函式庫的頁面與範例。結果格式為 {lib} {path} - {title}，同一份索引也支撐命令列閱讀器及其 search 子命令。內容來自各函式庫發佈的 llms-full.txt。
適用情境: 當你使用 pmndrs 系列函式庫，並希望助理查閱官方文件與範例而不是憑空猜測 API 時，值得加入。適合在撰寫程式期間處理 React Three Fiber、drei、zustand 或 jotai 相關問題。
執行需求: 遠端 streamable HTTP 端點位於 docs.pmnd.rs；未宣告驗證、環境變數或標頭。搭配的命令列工具透過 npx 執行，需要 Node.js，並將抓取的文件快取在 ~/.cache/pmndrs-docs。

安裝前請注意

此伺服器只做唯讀的文件查詢，不會寫入、傳送或刪除資料。文件取自第三方網站，因此查詢與頁面請求會送往該主機，命令列工具會在本機快取下載的檔案。

安裝

在 SourceWeft 中

開啟儀表板中的 pmndrs docs，將其新增到工作區。
為需要使用其工具的對話啟用該服務。

Web executable，透過 Streamable HTTP。遠端服務在工作區中設定後即可從網頁執行環境執行。

其他 MCP 客戶端

把它新增到你客戶端的 mcpServers 設定中。

{
  "mcpServers": {
    "docs": {
      "type": "http",
      "url": "https://docs.pmnd.rs/api/mcp"
    }
  }
}

README

[圖片] [圖片]

[圖片]

docs/getting-started/introduction.mdx

Usage

Read

$ npx @pmndrs/docs                                 # the reader: every library, every page$ npx @pmndrs/docs drei                            # straight into one$ npx @pmndrs/docs drei/performances/instances     # straight to a page$ npx @pmndrs/docs search instanced mesh           # one result per line, on stdout

$ npx @pmndrs/docs                                 # the reader: every library, every page$ npx @pmndrs/docs drei                            # straight into one$ npx @pmndrs/docs drei/performances/instances     # straight to a page$ npx @pmndrs/docs search instanced mesh           # one result per line, on stdout

↑↓ drives whichever pane has the focus — the list of pages, or the page itself. ⏎ or ⇥ hands the focus over, esc or ⇥ hands it back, and the lit border says where it is — the wheel moves whichever pane it points at, focus or no focus. ←→ changes library, b folds the sidebar away, / searches every library at once, o opens the page in a browser, q quits. Links inside a page are clickable wherever the terminal honours OSC 8 hyperlinks — iTerm2, Ghostty, WezTerm, Kitty, Windows Terminal.

search is the half a pipe or an agent can use: results read {lib} {path} - {title}, the shape the MCP server publishes its index in, and nothing found exits 1. --in drei narrows to one library, --in drei/performances/instances to the matching lines of one page.

Both read the published llms-full.txt of each library, cached for an hour under ~/.cache/pmndrs-docs — --refresh fetches again. Outside a terminal, a page target is written to stdout, so npx @pmndrs/docs drei/performances/instances | glow works.

Build

$ cat foo.mdx | npx @pmndrs/docs@latest build               # one HTML fragment, on stdout$ npx @pmndrs/docs@latest build docs out                    # one .html per .mdx, assets alongside$ npx @pmndrs/docs@latest build docs out --format website   # the whole website, statically exported

$ cat foo.mdx | npx @pmndrs/docs@latest build               # one HTML fragment, on stdout$ npx @pmndrs/docs@latest build docs out                    # one .html per .mdx, assets alongside$ npx @pmndrs/docs@latest build docs out --format website   # the whole website, statically exported

--format fragment (the default) needs nothing but node — no next build, no bundler. A fragment is the compiled MDX and nothing else: no layout, no stylesheet, no script. Mermaid diagrams stay fenced blocks, and Sandpack shows its code without the editor.

build --help lists every website option — --libname, --base-path, --icon, --theme-*… Each one falls back to the environment variable it maps to, the same ones configuration documents.

Preview a folder of MDX, served

$ curl -sL https://raw.githubusercontent.com/pmndrs/docs/refs/heads/main/preview.sh | \  MDX="docs" \  ICON="🥑" \  sh

$ curl -sL https://raw.githubusercontent.com/pmndrs/docs/refs/heads/main/preview.sh | \  MDX="docs" \  ICON="🥑" \  sh

Builds the website, then serves it — alongside the MDX folder itself, so relative assets resolve while you edit. Any option from configuration goes in the same way, and VERSION picks a published version of the CLI.

Releasing

Every push to main redeploys docs.pmnd.rs via ci.yml — no changeset needed for that.

Add one (pnpm changeset) only when downstream consumers pinning pmndrs/docs/.github/workflows/build.yml@v4 or @pmndrs/docs@4 should pull the change. It bumps package.json, publishes to npm, and tags vX.Y.Z + vX — so @v4 resolves to the latest.

TL;DR — site-only tweak: skip. Anything consumers see (workflow, build behavior, templates): add one.

Test

Visual tests are performed in the cloud, through chromatic.yml.

You can also replay locally:

$ npx playwright test --update-snapshots$ npx chromatic --playwright --project-token $CHROMATIC_PROJECT_TOKEN

$ npx playwright test --update-snapshots$ npx chromatic --playwright --project-token $CHROMATIC_PROJECT_TOKEN

來源：README.md，提交 0dabf27

工具

工具後設資料尚未被收錄。

版本歷史

v4.15.0最新Oct 2, 2026