Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WP Docs Finder

Standalone stdio MCP server for searching cached official WordPress developer documentation.

The bundled cache covers:

  • WordPress theme development docs
  • WordPress block editor docs

Tailwind docs are intentionally excluded because Tailwind has its own native MCP path.

Quick Install

From a cloned checkout:

pnpm install
pnpm run install:codex

With npm:

npm install
npm run install:codex

For Claude Code:

pnpm install
pnpm run install:claude-code

With npm:

npm install
npm run install:claude-code

For package-style setup after this repo is uploaded to GitHub:

bash scripts/install-codex.sh --package github:<owner>/wp-docs-finder
bash scripts/install-claude-code.sh --package github:<owner>/wp-docs-finder

Replace <owner> with the GitHub user or organization.

See INSTALL.md for manual config snippets and installer options.

Agentic Setup Prompt

Paste this into Codex, Claude Code, or another coding agent:

Install wp-docs-finder as an MCP server for me.

Repository:
https://github.com/<owner>/wp-docs-finder

Requirements:
- Inspect my existing MCP/client config before editing it.
- Prefer pnpm if available; use npx fallback only if pnpm is missing.
- For Codex, install the server as `wp-docs-finder` in `${CODEX_HOME:-$HOME/.codex}/config.toml`.
- For Claude Code, use `claude mcp add wp-docs-finder --scope local` unless I ask for user/project scope.
- Do not remove or rewrite unrelated MCP servers.
- Back up any config file before changing it.
- Verify the MCP server exposes `search_docs`, `get_doc`, and `list_doc_scopes`.
- After setup, run a test query for `theme.json color palette` and report the first result URL.

Manual Codex Config

Recommended package-style config:

[mcp_servers.wp-docs-finder]
command = "pnpm"
args = ["dlx", "github:<owner>/wp-docs-finder"]

Fallback for users without pnpm:

[mcp_servers.wp-docs-finder]
command = "npx"
args = ["-y", "github:<owner>/wp-docs-finder"]

Installed globally with npm:

npm install -g github:<owner>/wp-docs-finder
[mcp_servers.wp-docs-finder]
command = "wp-docs-finder"
args = []

Local development:

[mcp_servers.wp-docs-finder]
command = "node"
args = ["/absolute/path/to/wp-docs-finder/src/server.js"]

Manual Claude Code Install

Recommended package-style install:

claude mcp add wp-docs-finder --scope local -- pnpm dlx github:<owner>/wp-docs-finder

Fallback for users without pnpm:

claude mcp add wp-docs-finder --scope local -- npx -y github:<owner>/wp-docs-finder

Installed globally with npm:

npm install -g github:<owner>/wp-docs-finder
claude mcp add wp-docs-finder --scope local -- wp-docs-finder

Use --scope user instead of --scope local if you want the server available across all Claude Code projects.

Tools

  • search_docs: search WordPress theme and block editor docs.
  • get_doc: fetch a full cached chunk by id.
  • list_doc_scopes: show cached scope counts.

Development

Install dependencies:

pnpm install

Npm also works for consumers:

npm install

Run the server:

pnpm start

Refresh the docs cache:

pnpm run docs:update

Commit data/docs.jsonl and data/manifest.json after refreshing the cache.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages