Abilities API: Register Kit MCP Server

.distignore

@@ -7,8 +7,6 @@
 /node_modules
 /resources/frontend/css/*.map
 /tests
-/vendor/autoload.php
-/vendor/composer
 /vendor/convertkit/convertkit-wordpress-libraries/.git
 /vendor/convertkit/convertkit-wordpress-libraries/.github
 /vendor/convertkit/convertkit-wordpress-libraries/tests

.github/workflows/coding-standards.yml

@@ -117,9 +117,12 @@ jobs:
           tools: cs2pr
 
       # Installs wp-browser, Codeception, PHP CodeSniffer and anything else needed to run tests.
+      # jq is used to remove the wordpress/mcp-adapter package from composer.json, as it requires PHP 7.4+.
       - name: Run Composer
         working-directory: ${{ env.PLUGIN_DIR }}
-        run: composer update
+        run: |
+          jq 'del(.require."wordpress/mcp-adapter")' composer.json > composer.json.tmp && mv composer.json.tmp composer.json
+          composer update
 
       # Installs WordPress scripts for CSS and JS Coding Standards.
       - name: Run npm install

.github/workflows/deploy.yml

@@ -43,11 +43,13 @@ jobs:
             "resources/frontend/css/frontend.css"
             "resources/frontend/js/dist/frontend.min.asset.php"
             "resources/frontend/js/dist/frontend.min.js"
+            "vendor/autoload.php"
             "vendor/convertkit/convertkit-wordpress-libraries/src/class-convertkit-api-traits.php"
             "vendor/convertkit/convertkit-wordpress-libraries/src/class-convertkit-api-v4.php"
             "vendor/convertkit/convertkit-wordpress-libraries/src/class-convertkit-log.php"
             "vendor/convertkit/convertkit-wordpress-libraries/src/class-convertkit-resource-v4.php"
             "vendor/convertkit/convertkit-wordpress-libraries/src/class-convertkit-review-request.php"
+            "vendor/wordpress/mcp-adapter/mcp-adapter.php"
           )
 
           for file in "${files[@]}"; do

.scripts/create-plugin-zip.sh

@@ -14,11 +14,9 @@ zip -r convertkit.zip . \
 -x ".wordpress-org/*" \
 -x "log/*" \
 -x "tests/*" \
--x "vendor/composer/*" \
 -x "vendor/convertkit/convertkit-wordpress-libraries/.github" \
 -x "vendor/convertkit/convertkit-wordpress-libraries/tests/*" \
 -x "vendor/convertkit/convertkit-wordpress-libraries/composer.json" \
--x "vendor/autoload.php" \
 -x "*.distignore" \
 -x "*.env.*" \
 -x ".gitignore" \

composer.json

@@ -4,7 +4,8 @@
     "type": "project",
     "license": "GPLv3",
     "require": {
-        "convertkit/convertkit-wordpress-libraries": "2.1.6"
+        "convertkit/convertkit-wordpress-libraries": "2.1.6",
+        "wordpress/mcp-adapter": "^0.5.0"
     },
     "require-dev": {
         "php-webdriver/webdriver": "^1.0",

includes/blocks/class-convertkit-block.php

@@ -55,6 +55,28 @@ public function register( $blocks ) {
 
 	}
 
+	/**
+	 * Registers this block's MCP abilities.
+	 *
+	 * @since   3.4.0
+	 *
+	 * @param   array $abilities     Abilities to Register.
+	 * @return  array
+	 */
+	public function register_abilities( $abilities ) {
+
+		return array_merge(
+			$abilities,
+			array(
+				new ConvertKit_MCP_Ability_Block_List( $this ),
+				new ConvertKit_MCP_Ability_Block_Insert( $this ),
+				new ConvertKit_MCP_Ability_Block_Update( $this ),
+				new ConvertKit_MCP_Ability_Block_Delete( $this ),
+			)
+		);
+
+	}
+
 	/**
 	 * Returns this block's programmatic name, excluding the convertkit- prefix.
 	 *

includes/blocks/helpers/class-convertkit-block-post-helper.php

@@ -0,0 +1,301 @@
+<?php
+/**
+ * ConvertKit Block Post Helper class.
+ *
+ * @package ConvertKit
+ * @author ConvertKit
+ */
+
+/**
+ * Helper methods to find, insert, update and delete blocks within a WordPress Post's content.
+ *
+ * @package ConvertKit
+ * @author  ConvertKit
+ */
+class ConvertKit_Block_Post_Helper {
+
+	/**
+	 * Finds all blocks matching the given block name in a Post's content.
+	 *
+	 * @since   3.4.0
+	 *
+	 * @param   int    $post_id     Post ID.
+	 * @param   string $block_name  Programmatic Block Name.
+	 * @return  WP_Error|bool|array
+	 */
+	public static function find( $post_id, $block_name ) {
+
+		// Get post.
+		$post = get_post( $post_id );
+		if ( ! $post ) {
+			return new WP_Error(
+				'convertkit_block_post_helper_post_not_found',
+				/* translators: %d: post ID */
+				sprintf( __( 'No post exists with ID %d.', 'convertkit' ), $post_id )
+			);
+		}
+
+		// Parse blocks.
+		$blocks = parse_blocks( $post->post_content );
+		$found  = array();
+
+		$occurrence_index = 0;
+
+		foreach ( $blocks as $index => $block ) {
+			if ( ! isset( $block['blockName'] ) || $block['blockName'] !== $block_name ) {
+				continue;
+			}
+
+			$found[] = array(
+				'index'            => (int) $index,
+				'occurrence_index' => (int) $occurrence_index,
+				'attrs'            => $block['attrs'],
+			);
+
+			++$occurrence_index;
+		}
+
+		// If no blocks found, return false.
+		if ( empty( $found ) ) {
+			return false;
+		}
+
+		return $found;
+
+	}
+
+	/**
+	 * Inserts a new block into the Post's content at the specified position.
+	 *
+	 * @since   3.4.0
+	 *
+	 * @param   int    $post_id     Post ID.
+	 * @param   string $block_name  Programmatic Block Name.
+	 * @param   array  $attrs       Block Attributes.
+	 * @param   string $position    One of 'prepend', 'append', 'index'.
+	 * @param   int    $index       Zero-based top-level block index; only used when $position is 'index'.
+	 * @return  WP_Error|array
+	 */
+	public static function insert( $post_id, $block_name, $attrs, $position = 'append', $index = 0 ) {
+
+		// Get Post.
+		$post = get_post( $post_id );
+		if ( ! $post ) {
+			return new WP_Error(
+				'convertkit_block_post_helper_insert_block_post_not_found',
+				/* translators: %d: Post ID */
+				sprintf( __( 'No Post exists with ID %d.', 'convertkit' ), $post_id )
+			);
+		}
+
+		// Parse blocks.
+		$blocks = parse_blocks( $post->post_content );
+
+		// Build the new block to insert.
+		$new_block = array(
+			'blockName'    => $block_name,
+			'attrs'        => (array) $attrs,
+			'innerBlocks'  => array(),
+			'innerHTML'    => '',
+			'innerContent' => array(),
+		);
+
+		// Resolve $position into a concrete zero-based splice point in the
+		// top-level block array.
+		switch ( $position ) {
+			case 'prepend':
+				$insert_at = 0;
+				break;
+
+			case 'index':
+				$insert_at = max( 0, min( (int) $index, count( $blocks ) ) );
+				break;
+
+			case 'append':
+			default:
+				$insert_at = count( $blocks );
+				break;
+		}
+
+		// Splice in the new block.
+		array_splice( $blocks, $insert_at, 0, array( $new_block ) );
+
+		// Update Post.
+		$result = wp_update_post(
+			array(
+				'ID'           => $post_id,
+				'post_content' => serialize_blocks( $blocks ),
+			),
+			true
+		);
+
+		// Bail if the update failed.
+		if ( is_wp_error( $result ) ) {
+			return $result;
+		}
+
+		// Return the index the block was inserted at.
+		return array(
+			'post_id' => $post_id,
+			'index'   => $insert_at,
+		);
+
+	}
+
+	/**
+	 * Updates the attributes of an existing block in the Post's content.
+	 *
+	 * @since   3.4.0
+	 *
+	 * @param   int    $post_id           Post ID.
+	 * @param   string $block_name        Programmatic Block Name.
+	 * @param   int    $occurrence_index  Position to update block.
+	 * @param   array  $attrs             Block Attributes.
+	 * @return  WP_Error|array
+	 */
+	public static function update( $post_id, $block_name, $occurrence_index, $attrs ) {
+
+		// Get Post.
+		$post = get_post( $post_id );
+		if ( ! $post ) {
+			return new WP_Error(
+				'convertkit_block_post_helper_update_block_post_not_found',
+				/* translators: %d: post ID */
+				sprintf( __( 'No Post exists with ID %d.', 'convertkit' ), $post_id )
+			);
+		}
+
+		// Parse blocks.
+		$blocks      = parse_blocks( $post->post_content );
+		$update_at   = 0;
+		$block_index = 0;
+		$matched     = false;
+
+		foreach ( $blocks as $key => $block ) {
+			++$update_at;
+
+			// Skip if the block name does not match.
+			if ( ! isset( $block['blockName'] ) || $block['blockName'] !== $block_name ) {
+				continue;
+			}
+
+			// Update the block if the occurrence index matches.
+			if ( $block_index === (int) $occurrence_index ) {
+				$blocks[ $key ]['attrs'] = array_merge( (array) $block['attrs'], (array) $attrs );
+				$matched                 = true;
+				break;
+			}
+
+			++$block_index;
+		}
+
+		// Bail if the block was not found.
+		if ( ! $matched ) {
+			return new WP_Error(
+				'convertkit_block_post_helper_occurrence_not_found',
+				/* translators: 1: block name, 2: occurrence index, 3: post ID */
+				sprintf( __( 'No occurrence #%2$d of block %1$s found in post %3$d.', 'convertkit' ), $block_name, (int) $occurrence_index, $post_id )
+			);
+		}
+
+		// Update Post.
+		$result = wp_update_post(
+			array(
+				'ID'           => $post_id,
+				'post_content' => serialize_blocks( $blocks ),
+			),
+			true
+		);
+
+		// Bail if the update failed.
+		if ( is_wp_error( $result ) ) {
+			return $result;
+		}
+
+		// Return the index the block was updated at.
+		return array(
+			'post_id' => $post_id,
+			'index'   => ( $update_at - 1 ),
+		);
+
+	}
+
+	/**
+	 * Deletes a specific block from the Post's content.
+	 *
+	 * @since   3.4.0
+	 *
+	 * @param   int    $post_id           Post ID.
+	 * @param   string $block_name        Programmatic Block Name.
+	 * @param   int    $occurrence_index  Zero-based index among this block's occurrences in the post.
+	 * @return  WP_Error|array
+	 */
+	public static function delete( $post_id, $block_name, $occurrence_index ) {
+
+		// Get Post.
+		$post = get_post( $post_id );
+		if ( ! $post ) {
+			return new WP_Error(
+				'convertkit_block_post_helper_update_block_post_not_found',
+				/* translators: %d: post ID */
+				sprintf( __( 'No Post exists with ID %d.', 'convertkit' ), $post_id )
+			);
+		}
+
+		// Parse blocks.
+		$blocks      = parse_blocks( $post->post_content );
+		$delete_at   = 0;
+		$block_index = 0;
+		$matched     = false;
+
+		foreach ( $blocks as $key => $block ) {
+			++$delete_at;
+
+			// Skip if the block name does not match.
+			if ( ! isset( $block['blockName'] ) || $block['blockName'] !== $block_name ) {
+				continue;
+			}
+
+			// Update the block if the occurrence index matches.
+			if ( $block_index === (int) $occurrence_index ) {
+				unset( $blocks[ $key ] );
+				$blocks  = array_values( $blocks );
+				$matched = true;
+				break;
+			}
+
+			++$block_index;
+		}
+
+		// Bail if the block was not found.
+		if ( ! $matched ) {
+			return new WP_Error(
+				'convertkit_block_post_helper_occurrence_not_found',
+				/* translators: 1: block name, 2: occurrence index, 3: post ID */
+				sprintf( __( 'No occurrence #%2$d of block %1$s found in post %3$d.', 'convertkit' ), $block_name, (int) $occurrence_index, $post_id )
+			);
+		}
+
+		// Update Post.
+		$result = wp_update_post(
+			array(
+				'ID'           => $post_id,
+				'post_content' => serialize_blocks( $blocks ),
+			),
+			true
+		);
+
+		// Bail if the update failed.
+		if ( is_wp_error( $result ) ) {
+			return $result;
+		}
+
+		// Return the index the block was deleted from.
+		return array(
+			'post_id' => $post_id,
+			'index'   => ( $delete_at - 1 ),
+		);
+
+	}
+
+}