You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: classes/third-party/angie/README.md
+46-11Lines changed: 46 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,8 @@ The integration enables Angie to:
13
13
14
14
The integration consists of two main components:
15
15
16
-
1.**PHP REST API** (`class-angie.php`): WordPress REST API endpoints for task management
17
-
2.**MCP Server** (`src/mcp-server.ts`): TypeScript-based MCP server that bridges Angie AI with the REST API
16
+
1.**PHP REST API** (`class-angie-api.php`): WordPress REST API endpoints for task management
17
+
2.**MCP Server** (`src/progress-planner-mcp-server.ts`): TypeScript-based MCP server that bridges Angie AI with the REST API, bundled with Vite for browser compatibility
18
18
19
19
## Installation
20
20
@@ -29,7 +29,7 @@ The integration consists of two main components:
29
29
30
30
1.**Install Dependencies:**
31
31
```bash
32
-
cd third-party/angie
32
+
cdclasses/third-party/angie
33
33
npm install
34
34
```
35
35
@@ -38,12 +38,16 @@ The integration consists of two main components:
38
38
npm run build
39
39
```
40
40
41
-
This will compile the TypeScript code and generate `dist/mcp-server.js`.
41
+
This will:
42
+
- Compile TypeScript to JavaScript (`tsc`)
43
+
- Bundle all dependencies with Vite into a single ES module
The integration is automatically enabled when Progress Planner is active. The MCP server script will be automatically enqueued when the Angie plugin is detected.
@@ -237,8 +241,24 @@ To get a complete list of available task IDs, use the "Get Active Tasks" endpoin
-**Registration:** The integration is automatically instantiated in `classes/class-base.php`
250
+
251
+
### Build Process
252
+
253
+
The MCP server uses:
254
+
-**TypeScript** for type-safe development
255
+
-**Vite** for bundling dependencies (Angie SDK, MCP SDK, Zod) into a single ES module
256
+
-**ES Modules** for browser compatibility
257
+
258
+
The build process (`npm run build`) does the following:
259
+
1. Compiles TypeScript (`tsc`) - generates type definitions
260
+
2. Bundles with Vite - resolves all `import` statements and creates a single file
261
+
3. Outputs `dist/progress-planner-mcp-server.js` - ready for browser use
242
262
243
263
### How It Works
244
264
@@ -321,14 +341,29 @@ Check the debug log at `/wp-content/debug.log` for error messages.
321
341
322
342
**Solution:** This typically happens if the value hasn't changed. WordPress's `update_option()` returns false when the new value is the same as the old value.
323
343
344
+
### Module resolution errors in browser
345
+
346
+
**Solution:** Ensure you've run `npm run build` after making changes. The build process bundles all dependencies. Clear your browser cache (hard refresh: Cmd+Shift+R / Ctrl+Shift+F5) to load the new bundled file.
347
+
324
348
## Contributing
325
349
326
350
To extend this integration:
327
351
328
-
1. Add new methods to `/code/classes/rest/class-angie.php`
329
-
2. Register new routes in the `register_rest_endpoint()` method
330
-
3. Follow WordPress REST API best practices
331
-
4. Update this documentation
352
+
1.**Add new REST API endpoints:**
353
+
- Add new methods to `classes/third-party/angie/class-angie-api.php`
354
+
- Register new routes in the `register_rest_endpoint()` method
0 commit comments