Skip to content

Commit 6cc55bc

Browse files
committed
Add readme
1 parent 374e6ce commit 6cc55bc

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,28 @@
1-
swissspidy/ai-command
2-
=====================
1+
# WP-CLI as an MCP Host
32

3+
This repository is for the [CloudFest Hackathon 2025 project](https://hackathon.cloudfest.com/project/wp-cli-mcp-host/) to implement the [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) in the WordPress ecosystem, specifically integrating it with WP-CLI.
44

5+
The core innovation is transforming WordPress into an MCP Server and WP-CLI into an MCP Host through a new package, enabling direct AI interactions with WordPress installations during development. This approach provides developers with powerful AI capabilities without requiring a live site or REST API endpoints.
56

6-
[![Build Status](https://travis-ci.org/swissspidy/ai-command.svg?branch=master)](https://travis-ci.org/swissspidy/ai-command)
7+
**WordPress MCP Server Layer:**
78

8-
Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)
9+
1. Implementation of MCP Server interfaces in WordPress
10+
2. Resource providers for posts, pages, media, and other WordPress content types
11+
3. Tool definitions for common WordPress actions (content creation, media handling)
12+
4. Context providers for WordPress configuration and site state
913

10-
## Using
14+
**WP-CLI MCP Host Package:**
1115

12-
~~~
13-
wp hello-world
14-
~~~
16+
1. MCP Host implementation within WP-CLI framework
17+
2. New command namespace for AI operations
18+
3. Integration with (local and remote) LLM providers
19+
4. Transport layer for local WordPress communication
20+
21+
You can think of MCP as the "USB port for LLMs", a standard way for LLMs to interact with any third-party system using things like function calling.
22+
23+
While the Hackathon project focuses on WP-CLI, the _MCP Server_ is usage-agnostic. It could also be exposed via HTTP or so in the future.
24+
25+
The _MCP Host_, gets information (such as list of available tools) from the server and passes it on to the LLM (e.g. Gemini).
1526

1627
## Installing
1728

@@ -26,7 +37,7 @@ wp package install swissspidy/ai-command:@stable
2637
To install the latest development version of this package, use the following command instead:
2738

2839
```bash
29-
wp package install swissspidy/ai-command:dev-master
40+
wp package install swissspidy/ai-command:dev-main
3041
```
3142

3243
## Contributing
@@ -54,6 +65,3 @@ Once you've decided to commit the time to seeing your pull request through, [ple
5465
## Support
5566

5667
GitHub issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support
57-
58-
59-
*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

0 commit comments

Comments
 (0)