### Menu Management Examples Source: https://www.respira.press/docs/usage Examples for managing navigation menus, including listing existing menus and adding new menu items. ```text List all menus on my site ``` ```text Add a new menu item for "Services" after "About" in the main menu ``` -------------------------------- ### Taxonomy Management Examples Source: https://www.respira.press/docs/usage Examples for working with taxonomies like categories and tags, including listing categories and creating new ones. ```text List all categories on my blog ``` ```text Create a new category called "Tutorials" with slug "tutorials" ``` -------------------------------- ### Run Respira MCP Setup Wizard Source: https://www.respira.press/docs/quick-start-guide This command initiates the interactive setup wizard for the Respira WordPress MCP server. It validates your site URL and API key, tests the connection, and generates the necessary MCP configuration for your AI tool. Ensure you have Node.js and npm installed. ```bash npx @respira/wordpress-mcp-server --setup ``` -------------------------------- ### Media Management Examples Source: https://www.respira.press/docs/usage Examples for managing media files, such as listing all images or finding images that lack alt text. ```text List all images in my media library ``` ```text Find images without alt text and suggest descriptions ``` -------------------------------- ### Install Respira WordPress MCP Server via npm Source: https://www.respira.press/docs/index Installs the Respira WordPress MCP server globally using npm, allowing it to be run without direct installation or by using a setup wizard for guided configuration. ```bash npm install -g @respira/wordpress-mcp-server ``` ```bash npx -y @respira/wordpress-mcp-server ``` -------------------------------- ### Bulk Content Updates Examples Source: https://www.respira.press/docs/usage Examples demonstrating how to perform coordinated changes across multiple pages, such as updating copyright years or adding new content sections. ```text Update the footer copyright year to 2025 on all pages ``` ```text Find all pages with "Contact" in the title and add a new CTA section ``` -------------------------------- ### Troubleshooting: Windows 'npx' Not Recognized Source: https://www.respira.press/docs/configuration Provides solutions for the 'npx' command not being recognized on Windows systems. This includes using the full path to the `npx.cmd` executable or installing the package globally. ```bash C:\Program Files\nodejs\npx.cmd npm install -g @respira/wordpress-mcp-server ``` -------------------------------- ### Install and Run Respira MCP Server (npm) Source: https://www.respira.press/docs/introduction Installs and runs the Respira MCP server locally. This server acts as a bridge between your AI coding assistant and your WordPress site. It can be installed globally or run directly using npx. The `--setup` flag initiates an interactive configuration wizard. ```bash npx @respira/wordpress-mcp-server --setup ``` ```bash npm install -g @respira/wordpress-mcp-server npx @respira/wordpress-mcp-server ``` ```bash npx @respira/wordpress-mcp-server --list npx @respira/wordpress-mcp-server --test npx @respira/wordpress-mcp-server --help ``` -------------------------------- ### Install WordPress Plugin (Shell) Source: https://www.respira.press/docs/tools/plugins/install-plugin Installs a WordPress plugin using its slug or a ZIP URL. Specify 'wordpress.org' or 'url' for the source. Requires plugin management to be enabled. ```shell respira tools plugins wordpress_install_plugin --slugOrUrl "yoast-seo" respira tools plugins wordpress_install_plugin --slugOrUrl "https://example.com/plugin.zip" --source "url" ``` -------------------------------- ### Install WordPress Plugin Source: https://www.respira.press/docs/tools/plugins/install-plugin Installs a plugin from WordPress.org using its slug or from a provided ZIP URL. Requires plugin management to be enabled in Respira settings. ```APIDOC ## POST /websites/respira_press/wordpress_install_plugin ### Description Installs a plugin from WordPress.org or a ZIP URL. Requires plugin management to be enabled in Respira settings. Use with caution. ### Method POST ### Endpoint /websites/respira_press/wordpress_install_plugin ### Parameters #### Query Parameters - **slugOrUrl** (string) - Required - Plugin slug (from WordPress.org) or ZIP file URL - **source** (string) - Optional - Source type: "wordpress.org" or "url" ### Request Example ```json { "slugOrUrl": "wordpress-seo", "source": "wordpress.org" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **installed** (boolean) - Indicates if the plugin was installed. - **slug** (string) - The slug of the installed plugin. #### Response Example ```json { "success": true, "installed": true, "slug": "wordpress-seo" } ``` ### Notes - Experimental: enable plugin management in Respira settings first - Always verify plugin source before installing ``` -------------------------------- ### Respira WordPress MCP Server CLI Options Source: https://www.respira.press/docs/configuration Provides essential command-line interface options for managing the Respira WordPress MCP server. These include running the setup wizard, listing configured sites, testing connections, and accessing help. ```bash npx @respira/wordpress-mcp-server --setup # Run setup wizard npx @respira/wordpress-mcp-server --list # List configured sites npx @respira/wordpress-mcp-server --test # Test connection to default site npx @respira/wordpress-mcp-server --help # Show help ``` -------------------------------- ### MCP Server CLI Commands - Bash Source: https://www.respira.press/docs/mcp-install Lists common command-line interface (CLI) options for the Respira WordPress MCP server. These commands facilitate setup, listing configured sites, testing connections, and accessing help. ```bash npx @respira/wordpress-mcp-server --setup ``` ```bash npx @respira/wordpress-mcp-server --list ``` ```bash npx @respira/wordpress-mcp-server --test ``` ```bash npx @respira/wordpress-mcp-server --help ``` -------------------------------- ### Manage Respira WordPress MCP Server Sites and Connections Source: https://www.respira.press/docs/index Provides command-line interface (CLI) options for managing the Respira WordPress MCP server. Includes commands to list configured sites, test connections to the default site, and display help information. ```bash npx @respira/wordpress-mcp-server --list ``` ```bash npx @respira/wordpress-mcp-server --test ``` ```bash npx @respira/wordpress-mcp-server --help ``` -------------------------------- ### List WordPress Pages (Example Prompts) Source: https://www.respira.press/docs/tools/pages/list-pages Demonstrates how to call the wordpress_list_pages tool using natural language prompts for various filtering and searching scenarios. These examples cover listing all pages, filtering by status, and searching for specific terms. ```text List all pages on my WordPress site List draft pages Search pages for 'pricing' Show me pages 2 at a time ``` -------------------------------- ### Switching Between Sites CLI Source: https://www.respira.press/docs/usage Command-line interface commands for switching between managed WordPress sites. ```bash npx @respira/wordpress-mcp-server --list ``` -------------------------------- ### Get Core Web Vitals Source: https://www.respira.press/docs/usage This prompt requests the Core Web Vitals for a specified homepage, including LCP, FID, and CLS metrics, which are crucial for understanding user experience and SEO. ```text Get Core Web Vitals for my homepage ``` -------------------------------- ### Plugin Management Tools Source: https://www.respira.press/docs/tools/overview Manage WordPress plugins including listing, installing, activating, updating, and deleting. ```APIDOC ## Plugin Management Tools ### Description Tools for managing WordPress plugins. ### Tools - `wordpress_list_plugins`: Lists available plugins. - `wordpress_install_plugin`: Installs a new plugin. - `wordpress_activate_plugin`: Activates an installed plugin. - `wordpress_deactivate_plugin`: Deactivates an installed plugin. - `wordpress_update_plugin`: Updates an installed plugin. - `wordpress_delete_plugin`: Deletes an installed plugin. ### Example Usage To install a plugin: ``` wordpress_install_plugin(plugin_name='woocommerce') ``` To list all plugins: ``` wordpress_list_plugins() ``` ``` -------------------------------- ### Update Module with Admin Label Source: https://www.respira.press/docs/usage This example demonstrates how to update a specific module on a WordPress page using its admin label and page ID. This is particularly useful for page builders like Divi and Elementor for precise content modifications. ```text Update the module with admin_label "Hero Section" on page ID 123. Change the heading text to "Welcome to Our Site". ``` -------------------------------- ### Install MCP Server via npm Source: https://www.respira.press/docs/changelog Command to install the MCP server globally using npm. This makes the `respira-mcp-server` command available in your system's PATH. ```bash npm install -g @respira/wordpress-mcp-server ``` -------------------------------- ### Experimental Plugin Management Source: https://www.respira.press/docs/api-reference A set of experimental endpoints for managing plugins. This includes listing installed plugins, installing new plugins, activating and deactivating plugins, updating plugins, and deleting plugins. Note that plugin management is experimental and requires explicit enablement. ```HTTP GET /plugins ``` ```HTTP POST /plugins/install ``` ```HTTP POST /plugins/{slug}/activate ``` ```HTTP POST /plugins/{slug}/deactivate ``` ```HTTP POST /plugins/{slug}/update ``` ```HTTP DELETE /plugins/{slug} ``` -------------------------------- ### Create WordPress Comment (JSON Example) Source: https://www.respira.press/docs/tools/comments/create-comment This example demonstrates the JSON structure for creating a new WordPress comment. It includes essential fields like post ID, author details, and content. The 'parent' field can be used to designate a reply to an existing comment. ```json { "success": true, "id": 9002, "post_id": 101 } ``` -------------------------------- ### WordPress Get Theme Docs Source: https://www.respira.press/docs/tools/context/get-theme-docs Retrieves the documentation and a list of all available template files for the currently active WordPress theme. This is a read-only operation. ```APIDOC ## GET /wordpress/theme/docs ### Description Retrieves the documentation and a list of all available template files for the currently active WordPress theme. This is a read-only operation and is useful for debugging theme layout issues or before building custom page templates. ### Method GET ### Endpoint /wordpress/theme/docs ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **theme** (object) - An object containing theme details. - **name** (string) - The name of the active WordPress theme. - **version** (string) - The version of the active WordPress theme. - **templates** (array of strings) - A list of available template file names. - **notes** (string) - Additional theme-specific documentation or notes. #### Response Example ```json { "success": true, "theme": { "name": "My Theme", "version": "1.0.0" }, "templates": [ "front-page.php", "page.php", "single.php", "archive.php" ], "notes": "Theme-specific docs and template availability" } ``` ``` -------------------------------- ### Get Theme Documentation (REST API) Source: https://www.respira.press/docs/api-reference Retrieves documentation for the active theme and a list of available template files. This can help in understanding theme structure and capabilities. ```bash GET /context/theme-docs ``` -------------------------------- ### Full Example Request for WordPress Module Update Source: https://www.respira.press/docs/tools/builders/update-module Illustrates a complete request payload for the wordpress_update_module tool, demonstrating how to specify the builder, page ID, module identifier, and the desired updates. ```json { "builder": "divi", "pageId": 42, "moduleIdentifier": { "admin_label": "Hero CTA" }, "updates": { "attributes": { "button_text": "Start Free Trial" } } } ``` -------------------------------- ### WordPress Get Menu Item Source: https://www.respira.press/docs/tools/menus/get-menu-item Retrieves a single WordPress menu item by its unique identifier. ```APIDOC ## GET /wordpress/get_menu_item ### Description Retrieves a single WordPress menu item by its ID. ### Method GET ### Endpoint /wordpress/get_menu_item ### Parameters #### Query Parameters - **item_id** (number) - Required - The ID of the menu item to retrieve. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **item** (object) - Contains the details of the menu item. - **id** (number) - The unique identifier of the menu item. - **title** (string) - The title of the menu item. - **url** (string) - The URL associated with the menu item. - **parent** (number) - The ID of the parent menu item, or 0 if it's a top-level item. #### Response Example ```json { "success": true, "item": { "id": 1001, "title": "Home", "url": "/", "parent": 0 } } ``` ``` -------------------------------- ### Request Performance Analysis Source: https://www.respira.press/docs/usage This prompt requests a performance analysis of a specified homepage. The AI will provide insights into load times, image optimization, CSS/JS efficiency, and caching strategies. ```text Analyze the performance of my homepage ``` -------------------------------- ### Multi-Site Management Source: https://www.respira.press/docs/api-reference Switches to a different WordPress site in a multi-site setup. ```APIDOC ## POST /sites/switch ### Description Switch to a different WordPress site (for multi-site setups). ### Method POST ### Endpoint `/sites/switch` #### Request Body *(Details not provided in the source text)* ### Response *(Details not provided in the source text)* ``` -------------------------------- ### Plugin Management (Experimental) Source: https://www.respira.press/docs/api-reference Endpoints for managing plugins, including listing, installing, activating, deactivating, updating, and deleting. Note: This feature is experimental and disabled by default. ```APIDOC ## GET /plugins ### Description List all installed plugins with status and update availability. ### Method GET ### Endpoint `/plugins` ### Response *(Details not provided in the source text)* ``` ```APIDOC ## POST /plugins/install ### Description Install a plugin from WordPress.org or ZIP URL. ### Method POST ### Endpoint `/plugins/install` #### Request Body *(Details not provided in the source text)* ### Response *(Details not provided in the source text)* ``` ```APIDOC ## POST /plugins/{slug}/activate ### Description Activate a plugin. ### Method POST ### Endpoint `/plugins/{slug}/activate` ### Parameters #### Path Parameters - **slug** (string) - Required - The slug of the plugin to activate. ### Response *(Details not provided in the source text)* ``` ```APIDOC ## POST /plugins/{slug}/deactivate ### Description Deactivate a plugin. ### Method POST ### Endpoint `/plugins/{slug}/deactivate` ### Parameters #### Path Parameters - **slug** (string) - Required - The slug of the plugin to deactivate. ### Response *(Details not provided in the source text)* ``` ```APIDOC ## POST /plugins/{slug}/update ### Description Update a plugin to the latest version. ### Method POST ### Endpoint `/plugins/{slug}/update` ### Parameters #### Path Parameters - **slug** (string) - Required - The slug of the plugin to update. ### Response *(Details not provided in the source text)* ``` ```APIDOC ## DELETE /plugins/{slug} ### Description Delete a plugin (must be deactivated first). ### Method DELETE ### Endpoint `/plugins/{slug}` ### Parameters #### Path Parameters - **slug** (string) - Required - The slug of the plugin to delete. ### Response *(Details not provided in the source text)* ``` -------------------------------- ### MCP Server CLI Commands Source: https://www.respira.press/docs/changelog A collection of common command-line interface commands for the MCP server, including setup, listing sites, testing connections, and accessing help. ```bash npx @respira/wordpress-mcp-server --setup ``` ```bash npx @respira/wordpress-mcp-server --list ``` ```bash npx @respira/wordpress-mcp-server --test ``` ```bash npx @respira/wordpress-mcp-server --help ``` -------------------------------- ### WordPress Page Update Full Example Response Source: https://www.respira.press/docs/tools/pages/update-page A more detailed JSON response from updating a WordPress page, including title, status, and specific instructions for Respira's approval process. ```json { "id": 156, "title": "Welcome to Acme Corp", "slug": "home-respira-draft", "status": "draft", "respira_message": "Respira says: ✅ Created duplicate of 'Home' for safe editing. Review and approve at Respira → Approve Edits.", "respira_instructions": "Go to WordPress Admin → Respira → Approve Edits to review and publish changes.", "duplicate_created": true, "duplicate_id": 156, "original_id": 2, "approval_url": "https://yoursite.com/wp-admin/admin.php?page=respira-approvals" } ``` -------------------------------- ### WPBakery Module Identification Examples (JSON) Source: https://www.respira.press/docs/builders/wpbakery Demonstrates various methods for identifying and targeting specific WPBakery modules. These include identification by Element ID (recommended), a custom CSS class, the element's path within the structure, or by matching its type and content. ```json { "admin_label": "hero-cta" } ``` ```json { "admin_label": "main-cta-button" } ``` ```json { "path": "rows[0].columns[0].elements[1]" } ``` ```json { "type": "vc_btn", "match_content": "Get Started" } ``` -------------------------------- ### Get WordPress Post Type Details (Shell) Source: https://www.respira.press/docs/tools/custom-posts/get-post-type Retrieve details for a specific WordPress post type using a shell command. This requires the post type name as input and returns a JSON object with post type information. Example prompts include getting details for 'product' or 'event' post types. ```shell curl "https://api.example.com/wordpress_get_post_type?type=product" ``` -------------------------------- ### Multi-Site Site Switching Source: https://www.respira.press/docs/api-reference Endpoint for switching between different WordPress sites within a multi-site setup. This is essential for managing multiple sites from a single installation. ```HTTP POST /sites/switch ``` -------------------------------- ### Beaver Builder Module Identification Examples (JSON) Source: https://www.respira.press/docs/builders/beaver-builder Demonstrates various methods for identifying specific modules within a Beaver Builder layout, including by node label, CSS ID, path, and by type and content. ```json { "admin_label": "Hero Heading" } ``` ```json { "admin_label": "hero-cta" } ``` ```json { "path": "rows[0].columns[0].modules[0]" } ``` ```json { "type": "heading", "match_content": "Welcome" } ``` -------------------------------- ### Get Site Information (REST API) Source: https://www.respira.press/docs/api-reference Retrieves comprehensive information about the WordPress site, including its version, theme, installed plugins, and detected page builders. This endpoint is useful for understanding the site's technical configuration. ```bash GET /context/site-info ``` -------------------------------- ### Create WordPress Menu Source: https://www.respira.press/docs/tools/menus/create-menu Creates a new navigation menu in WordPress with a specified name and an optional description. ```APIDOC ## POST /wordpress/menus ### Description Creates a new navigation menu in WordPress. ### Method POST ### Endpoint /wordpress/menus ### Parameters #### Request Body - **name** (string) - Required - The name of the menu to create. - **description** (string) - Optional - A description for the menu. ### Request Example ```json { "name": "Primary Menu", "description": "Main navigation menu for the website" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the menu creation was successful. - **id** (integer) - The unique identifier of the newly created menu. - **name** (string) - The name of the created menu. #### Response Example ```json { "success": true, "id": 10, "name": "Primary Menu" } ``` ``` -------------------------------- ### Get Single Media Item Source: https://www.respira.press/docs/tools/media/get-media Retrieves detailed information for a single WordPress media item based on its ID. ```APIDOC ## GET /websites/respira_press/wordpress_get_media ### Description Get single media item details. ### Method GET ### Endpoint /websites/respira_press/wordpress_get_media ### Parameters #### Query Parameters - **id** (number) - Required - Media ID ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **id** (number) - The unique identifier for the media item. - **title** (string) - The title of the media item. - **alt** (string) - The alternative text for the media item. - **caption** (string) - The caption for the media item. - **sourceUrl** (string) - The URL where the media item is hosted. #### Response Example ```json { "success": true, "id": 501, "title": "Hero Image", "alt": "A person working on a laptop", "caption": "", "sourceUrl": "https://example.com/wp-content/uploads/hero.jpg" } ``` ``` -------------------------------- ### Beaver Builder Data Structure Example (JSON) Source: https://www.respira.press/docs/builders/beaver-builder Illustrates the nested structure of Beaver Builder layouts, showing how rows, columns, and modules are organized as serialized PHP arrays within post meta. ```json { "node-abc123": { "node": "abc123", "type": "row", "settings": { "width": "fixed" } }, "node-def456": { "node": "def456", "type": "column", "parent": "abc123", "settings": { "size": "100" } }, "node-ghi789": { "node": "ghi789", "type": "module", "parent": "def456", "settings": { "type": "heading", "heading": "Welcome to Our Site", "tag": "h1" } } } ``` -------------------------------- ### GET /wordpress/get_option Source: https://www.respira.press/docs/tools/options/get-option Retrieves a specific WordPress option value by its name. This is useful for accessing configuration settings or metadata stored in WordPress. ```APIDOC ## GET /wordpress/get_option ### Description Retrieves a specific WordPress option value by its name. This is useful for accessing configuration settings or metadata stored in WordPress. ### Method GET ### Endpoint /wordpress/get_option ### Parameters #### Query Parameters - **option** (string) - Required - The name of the WordPress option to retrieve. ### Request Example ``` GET /wordpress/get_option?option=blogname ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **option** (string) - The name of the option that was retrieved. - **value** (any) - The value of the requested option. #### Response Example ```json { "success": true, "option": "blogname", "value": "My Site" } ``` ``` -------------------------------- ### Get WordPress Post Type Source: https://www.respira.press/docs/tools/custom-posts/get-post-type Retrieves details for a specific WordPress post type, such as its label, public visibility, and name. ```APIDOC ## GET /wordpress/post_type ### Description Retrieves details for a specific WordPress post type. ### Method GET ### Endpoint /wordpress/post_type ### Parameters #### Query Parameters - **type** (string) - Required - Post type name ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **type** (string) - The name of the post type. - **label** (string) - The human-readable label for the post type. - **public** (boolean) - Indicates if the post type is publicly accessible. #### Response Example ```json { "success": true, "type": "product", "label": "Products", "public": true } ``` ``` -------------------------------- ### GET /wordpress/comment Source: https://www.respira.press/docs/tools/comments/get-comment Retrieves a specific WordPress comment by its ID. This endpoint is useful for fetching individual comment details such as author, content, and associated post. ```APIDOC ## GET /wordpress/comment ### Description Retrieves a specific WordPress comment by its ID. ### Method GET ### Endpoint /wordpress/comment ### Parameters #### Query Parameters - **id** (number) - Required - The unique identifier of the comment to retrieve. ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **id** (number) - The comment ID. - **post_id** (number) - The ID of the post the comment belongs to. - **author** (string) - The name of the comment author. - **author_email** (string) - The email address of the comment author. - **content** (string) - The content of the comment. #### Response Example ```json { "success": true, "id": 9001, "post_id": 101, "author": "Jane", "author_email": "jane@example.com", "content": "Great post!" } ``` ``` -------------------------------- ### Full Example Response for WordPress Module Update Source: https://www.respira.press/docs/tools/builders/update-module A detailed response from a successful module update, including confirmation of success, module details, applied changes, and additional information like duplicate creation status and an approval URL. ```json { "success": true, "message": "Module 'Hero CTA' updated successfully", "module_found": true, "module_type": "et_pb_button", "module_path": "sections[0].rows[0].columns[0].modules[1]", "changes_applied": { "button_text": "Start Free Trial" }, "duplicate_created": true, "duplicate_id": 156, "approval_url": "https://yoursite.com/wp-admin/admin.php?page=respira-approvals" } ``` -------------------------------- ### Get Term by ID Source: https://www.respira.press/docs/tools/taxonomies/get-term Retrieves a specific taxonomy term from WordPress by its unique ID and taxonomy name. Useful for fetching details of categories, tags, or other custom taxonomies. ```APIDOC ## GET /wordpress/term ### Description Retrieves a specific taxonomy term from WordPress by its unique ID and taxonomy name. Useful for fetching details of categories, tags, or other custom taxonomies. ### Method GET ### Endpoint /wordpress/term ### Parameters #### Query Parameters - **taxonomy** (string) - Required - Taxonomy name (e.g., 'category', 'post_tag'). - **id** (number) - Required - The unique identifier for the term. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **taxonomy** (string) - The name of the taxonomy the term belongs to. - **term** (object) - An object containing the term's details: - **id** (number) - The term's unique identifier. - **name** (string) - The display name of the term. - **slug** (string) - The URL-friendly slug for the term. - **description** (string) - The description of the term, if available. #### Response Example ```json { "success": true, "taxonomy": "category", "term": { "id": 12, "name": "News", "slug": "news", "description": "" } } ``` ``` -------------------------------- ### List WordPress Menus Source: https://www.respira.press/docs/tools/menus/list-menus Retrieves a list of all navigation menus configured in WordPress. This includes menu IDs and names, along with WPML translation details if the WPML plugin is active. ```APIDOC ## GET /wordpress/list_menus ### Description Lists all navigation menus available in WordPress. Includes WPML translation info if available. ### Method GET ### Endpoint /wordpress/list_menus ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful. - **menus** (array) - A list of menu objects. - **id** (integer) - The unique identifier for the menu. - **name** (string) - The name of the menu. #### Response Example ```json { "success": true, "menus": [ { "id": 10, "name": "Primary Menu" } ] } ``` ``` -------------------------------- ### Checking Node.js Version (Bash) Source: https://www.respira.press/docs/troubleshooting Verify that you have Node.js version 18 or higher installed, which is a requirement for the Respira MCP server. This command displays the currently installed Node.js version. ```bash node --version ``` -------------------------------- ### Options Management Tools Source: https://www.respira.press/docs/tools/overview Manage WordPress options (settings) including listing, retrieving, updating, and deleting. ```APIDOC ## Options Management Tools ### Description Tools for managing WordPress site options and settings. ### Tools - `wordpress_list_options`: Lists all options. - `wordpress_get_option`: Retrieves a specific option value. - `wordpress_update_option`: Updates an existing option. - `wordpress_delete_option`: Deletes an option. ### Example Usage To get an option value: ``` wordpress_get_option(option_name='blogdescription') ``` To update an option: ``` wordpress_update_option(option_name='blogname', option_value='My New Blog Title') ``` ``` -------------------------------- ### Get WordPress Comment by ID Source: https://www.respira.press/docs/tools/comments/get-comment Retrieves a specific WordPress comment using its unique identifier. Requires the comment ID as input. Returns a JSON object containing comment details or an error if the comment is not found. ```json { "success": true, "id": 9001, "post_id": 101, "author": "Jane", "author_email": "jane@example.com", "content": "Great post!" } ``` -------------------------------- ### Module Identification by Type and Content Source: https://www.respira.press/docs/builders/thrive-architect Explains how to identify Thrive Architect modules by their type and matching content. This is useful for finding elements based on their visible text or attributes, offering a flexible identification method. ```json { "type": "button", "match_content": "Get Started" } ``` -------------------------------- ### Module Identification by Custom Class Source: https://www.respira.press/docs/builders/thrive-architect Demonstrates how to identify Thrive Architect modules using a custom class, which is the recommended method for targeting specific elements. This approach provides a stable way to reference elements even if their IDs change. ```json { "admin_label": "hero-cta" } ``` -------------------------------- ### Get WordPress Term by ID and Taxonomy Source: https://www.respira.press/docs/tools/taxonomies/get-term Fetches a specific taxonomy term from WordPress by providing its ID and the taxonomy name. This tool is useful for retrieving detailed information about a term, such as its name, slug, and description. It requires the 'taxonomy' and 'id' as parameters. ```tool_code print(tool_code.wordpress_get_term(taxonomy='category', id=12)) ``` -------------------------------- ### Get WordPress Media Item by ID Source: https://www.respira.press/docs/tools/media/get-media Fetches details for a single WordPress media item using its ID. Requires a media ID as input. Returns a JSON object containing media properties like title, alt text, and source URL. ```json { "success": true, "id": 501, "title": "Hero Image", "alt": "A person working on a laptop", "caption": "", "sourceUrl": "https://example.com/wp-content/uploads/hero.jpg" } ``` -------------------------------- ### Module Identification by Path Source: https://www.respira.press/docs/builders/thrive-architect Illustrates identifying a Thrive Architect module by its hierarchical path within the element tree. This method is useful for precise targeting within deeply nested structures but can be brittle if the structure changes. ```json { "path": "elements[0].children[0].children[1]" } ``` -------------------------------- ### WPBakery Data Structure Example Source: https://www.respira.press/docs/builders/wpbakery Illustrates how WPBakery stores page layouts as nested shortcodes within the 'post_content'. Each shortcode represents a building block, and attributes within these shortcodes control their appearance and behavior. ```text [vc_row][vc_column] [vc_column_text el_id="hero-text"]

Welcome to Our Site

We help businesses grow.

[/vc_column_text] [vc_btn title="Get Started" link="url:/contact" el_id="hero-cta"] [/vc_column][/vc_row] [vc_row][vc_column width="1/2"] [vc_single_image image="123" img_size="full"] [/vc_column][vc_column width="1/2"] [vc_column_text]

Our Services

[/vc_column_text] [/vc_column][/vc_row] ``` -------------------------------- ### POST /wordpress/custom_post Source: https://www.respira.press/docs/tools/custom-posts/create-custom-post Creates a new custom post with the specified type, title, content, and status. ```APIDOC ## POST /wordpress/custom_post ### Description Creates a new custom post for a given post type with a specified title, content, and status. ### Method POST ### Endpoint /wordpress/custom_post ### Parameters #### Request Body - **type** (string) - Required - Post type name - **title** (string) - Required - Post title - **content** (string) - Optional - Post content - **status** (string) - Optional - Post status (default: draft) ### Request Example ```json { "type": "product", "title": "Starter Plan", "content": "This is the content for the starter plan.", "status": "publish" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **type** (string) - The post type that was created. - **id** (integer) - The ID of the newly created post. - **status** (string) - The status of the newly created post. #### Response Example ```json { "success": true, "type": "product", "id": 3002, "status": "draft" } ``` ``` -------------------------------- ### Get WordPress Page Builder Information Source: https://www.respira.press/docs/tools/context/get-builder-info This function retrieves details about the active WordPress page builder and lists its available modules or widgets. It takes no parameters and returns a JSON object containing success status, builder name, and a list of modules with their types and labels. This is useful for understanding the site's structure and confirming builder compatibility. ```json { "success": true, "builder": "divi", "modules": [ { "type": "et_pb_text", "label": "Text" }, { "type": "et_pb_button", "label": "Button" } ] } ``` -------------------------------- ### WordPress Get User API Source: https://www.respira.press/docs/tools/users/get-user Retrieves specific user details from WordPress by providing the user's unique ID. ```APIDOC ## GET /wordpress/users/{id} ### Description Retrieves WordPress user details by user ID. ### Method GET ### Endpoint /wordpress/users/{id} ### Parameters #### Path Parameters - **id** (number) - Required - User ID ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **id** (number) - The unique identifier for the user. - **username** (string) - The user's login username. - **email** (string) - The user's email address. - **display_name** (string) - The name displayed for the user. - **roles** (array) - A list of roles assigned to the user. #### Response Example ```json { "success": true, "id": 1, "username": "admin", "email": "admin@example.com", "display_name": "Site Admin", "roles": [ "administrator" ] } ``` ```