Skip to content
Merged
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
5e57734
Add Docs folder and basic structure for documentation.
zzap Mar 16, 2025
c695f45
Update README with Cloudfest Hackathon contributors list.
zzap Mar 16, 2025
433e735
Add GH links to contributors list.
zzap Mar 16, 2025
96432cf
Add depenednecy.
zzap Mar 16, 2025
c5b0810
Add code reference for AiCommand class; list available tools.
zzap Mar 16, 2025
73e70b8
Add reference for Client class.
zzap Mar 16, 2025
2efd55b
Completed reference for Client class. Clean up formatting.
zzap Mar 16, 2025
5481e4f
Add reference and examples for Server class.
zzap Mar 16, 2025
f5ebc8b
Add prompts examples and tool gif.
zzap Mar 16, 2025
b87c37c
Merge branch 'main' into feature/docs
zzap Mar 16, 2025
30401e5
Docs for updated Server class, and new RouteInformation and MapRESTto…
zzap Mar 16, 2025
a9acca6
Merge branch 'main' into feature/docs
zzap Mar 16, 2025
6399fff
Add table of contents for the reference docs.
zzap Mar 16, 2025
92178ed
Remove redundant heading.
zzap Mar 16, 2025
a944304
Merge branch 'main' into feature/docs
zzap Mar 16, 2025
91d628e
Update docs for Client class to include return value.
zzap Mar 16, 2025
c624bb6
Update docs for AiCommand class to include return value. List all RES…
zzap Mar 16, 2025
9cad79e
Update reference for all existing docs.
zzap Mar 16, 2025
ed0a5bd
Add reference for MediaManager class.
zzap Mar 16, 2025
bf256ee
Add reference for ImageTools class.
zzap Mar 16, 2025
e6ec96c
Update ToC
zzap Mar 16, 2025
6a3a7c9
Add examples for predefined tools.
zzap Mar 17, 2025
98fdabc
Add basic overwiev docs.
zzap Mar 17, 2025
f196fa4
Docs update. Rename the main docs file to README so it automatically …
zzap Mar 17, 2025
f724e83
Merge branch 'main' into feature/docs
zzap Mar 17, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# WP-CLI AI Command Documentation

## Introduction

This documentation aims to explain usage, as well as present the technical specification for `ai` WP-CLI command.

Table of contents:
- [Reference](reference.md)
- [Tools](tools.md)
- [Cookbook](prompts-cookbook.md)

### Dependencies

- [WordPress](https://wordpress.org/download/)
- [WP-CLI](https://make.wordpress.org/cli/handbook/guides/installing/)
- [AI Services](https://github.com/felixarntz/ai-services/) plugin by [Felix Arntz](https://github.com/felixarntz).

## Problem

WordPress development workflows currently lack seamless integration with AI capabilities, particularly during local development. While REST API endpoints enable AI interactions with live sites, developers working with local WordPress installations have limited options for AI-assisted content creation and site management. This project aims to bridge this gap by implementing the Model Context Protocol (MCP) in the WordPress ecosystem, specifically integrating it with WP-CLI.

## Key features

- The foundation for AI-powered WordPress usage and development
- Make it easy to integrate MCP Server to LLM providers (Claude, Cursor etc)
- Integrate MCP Server in to Core, MCP Client in to WP-CLI