- Home
- MCP servers
- BOIM WP
BOIM WP
- typescript
6
GitHub Stars
typescript
Language
5 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"jtruax-boim-wp-mcp": {
"command": "node",
"args": [
"/full/path/to/BOIM-WP-MCP/dist/index.js"
]
}
}
}You run a specialized MCP server that provides WordPress development guidance, code generation, and best practices for Gutenberg blocks, the GeneratePress ecosystem, and WPCodebox snippets. It helps you generate code, validate standards, and follow security, performance, and compatibility guidelines without needing to visit multiple sources.
How to use
You connect to the MCP server through your client (Claude Desktop or Cursor) and start by ensuring the server process is running locally. Use the built-in tools to generate Gutenberg blocks, craft GenerateBlocks-compatible code, format WPCodebox snippets, and apply WordPress coding standards for PHP, JavaScript, and CSS. Request practical outputs like a complete Gutenberg block, a GenerateBlocks template, or a WPCodebox-formatted snippet, then iterate with the client’s feedback loop until your code meets your project’s requirements.
How to install
Prerequisites you need on your machine:
Node.js 18.0.0 or higher
npm or yarn
A MCP-capable client like Claude Desktop or Cursor
Install and build the MCP server
git clone https://github.com/JTruax/BOIM-WP-MCP.git
cd BOIM-WP-MCP
npm install
npm run build
Locate the built server entry
The build creates a dist/index.js file. You will reference the full path to this file when configuring your MCP client.
Configure your MCP client to run the server locally
// Example path to your built server (adjust to your system)
/full/path/to/BOIM-WP-MCP/dist/index.js
Start the MCP server from the client
In your MCP client, configure a stdio-based server that launches the Node process and runs the built script. You will provide the command and arguments as shown below.
name: wordpress_gutenberg
command: node
args: ["/full/path/to/BOIM-WP-MCP/dist/index.js"]
Test the connection
Restart your MCP client to load the new server configuration. Confirm the server appears in the MCP server list, then run a quick test such as requesting a Gutenberg block example or formatting a WPCodebox snippet to verify the integration is working.
Additional sections
The server includes tools for code generation, coding standards validation, and knowledge resources covering Gutenberg, GenerateBlocks, and GeneratePress best practices. Use these outputs to accelerate WordPress development while ensuring security, performance, and compatibility.
Troubleshooting
If the MCP server does not appear or respond, verify the following: the path to dist/index.js is absolute, you ran the build successfully, and Node.js is installed at a compatible version (18.0.0+). Restart Claude Desktop or Cursor completely after changes.
If you encounter a command not found error, ensure Node.js is in your system PATH or use the full path to the node executable.
For JSON syntax issues in any config, validate with a JSON linter and ensure proper escaping of characters.
Available tools
format_wpcodebox_snippet
Format a WPCodebox code snippet to align with WPCodebox formatting conventions.
get_wpcodebox_guidelines
Retrieve guidelines for WPCodebox snippet structure and usage.
validate_wpcodebox_snippet
Validate that a WPCodebox snippet follows the required schema and formatting rules.
generate_gutenberg_block
Generate a complete Gutenberg block including block.json, PHP registration, and React components.
generate_block_variation
Create a variation of an existing Gutenberg block with customized attributes.
generate_block_pattern
Produce a Gutenberg block pattern ready for insertion into the editor.
get_gutenberg_standards
Provide development standards and best practices for Gutenberg blocks.
generate_gb_block
Generate a GenerateBlocks-compatible block code snippet.
generate_gb_styles
Create GenerateBlocks-specific CSS styles for a block.
generate_gb_template
Generate a GenerateBlocks template configuration.
get_generateblocks_guide
Access the GenerateBlocks development guide.
generate_php_function
Generate a WordPress PHP function for common tasks.
generate_hook
Generate a WordPress action or filter hook with a callback.
generate_shortcode
Create a WordPress shortcode with its handler function.
generate_rest_endpoint
Generate a WordPress REST API endpoint with routes and callbacks.
format_for_wpcodebox
Format arbitrary code snippets for WPCodebox compatibility.