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