Getting Started ๐
Welcome to MCP for WP! This guide will walk you through the essential first steps to get the plugin up and running. Let's get started!
๐ฆ Step 1: Installation
First things first, let's get the plugin installed and activated on your WordPress site.
-
Download or Clone the Plugin: You can either download the plugin as a ZIP file from the repository or clone it using Git.
bashgit clone https://github.com/artificialpoets/mcp-wp-docs.git
-
Upload to WordPress: Copy the
wp-mcp/
folder into yourwp-content/plugins/
directory. -
Activate the Plugin: From your WordPress admin dashboard, navigate to the Plugins page and click Activate next to "MCP for WP".
โ๏ธ Step 2: Initial Configuration
Now that the plugin is active, let's configure it with your AI provider.
-
Navigate to Settings: Go to MCP for WP > Settings in your WordPress admin menu.
-
Enter API Key: Enter your API key from your chosen AI provider (e.g., OpenAI).
-
Save Changes: Click the "Save Changes" button to store your configuration.
๐ Initial Setup Process
Here's a visual overview of the complete setup process:
๐ ๏ธ Step 3: Define Your First AI Tool
With the initial setup complete, it's time to create your first AI tool!
-
Add a New Tool: Go to MCP for WP > Add New.
-
Fill in the Details: Provide a name, description, select the provider and method, and define the JSON schemas for your tool.
-
Save the Tool: Once you've filled everything in, click "Save". Your new tool will now appear in the dashboard list.
๐งช Step 4: Test Your Tool
Let's make sure your new tool works as expected.
- Execute the Tool: Use the provided REST API endpoint or the shortcode to run your tool.
- Check the Logs: View the execution details and any potential errors in MCP for WP > Logs.
๐ Next Steps
Congratulations on setting up your first tool! Here are a few suggestions for what to explore next:
- Dive into the Admin UI Guide for a complete tour of all plugin screens.
- Learn about advanced configurations in the Tool Management guide.
๐ค Troubleshooting
Running into issues? Here are a few common solutions:
- Menu Not Visible?: Try clearing your browser cache and ensure your user role has the necessary permissions.
- API Errors?: Double-check that your API key is correct and that your provider's service is operational.
- For more detailed help, check out our full Troubleshooting Guide.