Skip to content

Commit 732ee07

Browse files
authored
Add Devin CLI output (#42)
1 parent 147ca9d commit 732ee07

14 files changed

Lines changed: 24376 additions & 2 deletions

File tree

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Shared source for WordPress-focused agent skills and plugin packaging.
44

5-
This repo currently packages shared skills and setup files for Codex, Claude Code, Cursor, Continue, Factory Droid, GitHub Copilot, Gemini, Roo Code, Windsurf/Cascade, Aider, and Zed as separate outputs:
5+
This repo currently packages shared skills and setup files for Codex, Claude Code, Cursor, Continue, Devin CLI, Factory Droid, GitHub Copilot, Gemini, Roo Code, Windsurf/Cascade, Aider, and Zed as separate outputs:
66

77
- prefers the WordPress Studio MCP server for site management, screenshots, and block validation
88
- falls back to the Studio CLI through a shared Studio skill when MCP is unavailable
@@ -16,6 +16,7 @@ This repo currently packages shared skills and setup files for Codex, Claude Cod
1616
- includes an Aider config and conventions pack for terminal pair-programming
1717
- keeps skills shared so other surfaces can reuse them later
1818
- includes Continue-native setup files for WordPress.com rules, prompts, and MCP configuration
19+
- includes Devin CLI project config, rules, and skills under Devin's documented `.devin/` surfaces
1920
- adds Roo Code workspace rules and project MCP config without introducing a Roo-specific backend service
2021
- adds Zed project instructions, project-local skills, and project settings for MCP without introducing a Zed-specific backend service
2122
- adds Windsurf/Cascade workspace rules and MCP config without introducing a Windsurf-specific backend service
@@ -176,6 +177,24 @@ droid plugin install wordpress-studio@wordpress-studio --scope project
176177

177178
4. In Droid, confirm the `wordpress-studio` and `wordpress-telemetry` MCP servers are available, then try representative WordPress.com tasks.
178179

180+
### Test in Devin CLI
181+
182+
1. Review the generated Devin output in `./plugins/devin`.
183+
2. Confirm the generated setup files exist:
184+
- `plugins/devin/README.md`
185+
- `plugins/devin/AGENTS.md`
186+
- `plugins/devin/.devin/config.json`
187+
- `plugins/devin/.devin/skills/`
188+
- `plugins/devin/scripts/wordpress-telemetry-mcp.mjs`
189+
3. Open `./plugins/devin` as the Devin CLI project root, or copy `AGENTS.md` and `.devin/` into a target project root.
190+
4. Confirm Devin CLI can see the configured `wordpress-studio` and `wordpress-telemetry` MCP servers.
191+
5. Try the same representative tasks:
192+
- creating a new site
193+
- building or editing a theme
194+
- creating a custom block
195+
- creating a custom plugin
196+
- running an audit request
197+
179198
## Current scope
180199

181200
- Shared skills for:
@@ -194,6 +213,7 @@ droid plugin install wordpress-studio@wordpress-studio --scope project
194213
- Cursor packaging output in `plugins/cursor/`
195214
- Continue setup output in `plugins/continue/`
196215
- Factory Droid marketplace output in `plugins/factory/`
216+
- Devin CLI setup output in `plugins/devin/`
197217
- Roo Code workspace output in `plugins/roo-code/`
198218
- Gemini packaging output in `plugins/gemini/`
199219
- GitHub Copilot packaging output in `plugins/copilot/`
@@ -220,6 +240,7 @@ The build packages the shared skills into:
220240
- `plugins/zed/.agents/skills/`
221241
- `plugins/windsurf/skills/`
222242
- `plugins/aider/skills/`
243+
- `plugins/devin/.devin/skills/`
223244

224245
It also generates plugin-specific MCP configs for each surface:
225246

@@ -228,6 +249,7 @@ It also generates plugin-specific MCP configs for each surface:
228249
- Cursor: `plugins/cursor/mcp.json`
229250
- Continue: `plugins/continue/.continue/mcpServers/wordpress-com.yaml`
230251
- Factory Droid: `plugins/factory/plugins/wordpress-studio/mcp.json`
252+
- Devin CLI: `plugins/devin/.devin/config.json`
231253
- Roo Code: `plugins/roo-code/.roo/mcp.json`
232254
- Gemini: `plugins/gemini/.gemini/settings.json`
233255
- GitHub Copilot: `plugins/copilot/.vscode/mcp.json`
@@ -369,6 +391,31 @@ The generated Factory Droid MCP config launches both `studio mcp` and the bundle
369391
- https://docs.factory.ai/cli/configuration/mcp
370392
- https://docs.factory.ai/reference/hooks-reference
371393

394+
The Devin CLI setup output is generated to:
395+
396+
```text
397+
plugins/devin/
398+
```
399+
400+
That folder currently contains:
401+
402+
- `AGENTS.md`
403+
- `.devin/config.json`
404+
- `.devin/skills/`
405+
- `scripts/wordpress-telemetry-mcp.mjs`
406+
- `README.md`
407+
408+
The generated Devin config launches both `studio mcp` and the bundled `wordpress-telemetry` MCP server through Devin's documented project config surface. Devin's official docs support project rules in `AGENTS.md`, project skills in `.devin/skills/<name>/SKILL.md`, and project MCP servers in `.devin/config.json`.
409+
410+
Official Devin references:
411+
412+
- Extensibility overview: https://docs.devin.ai/cli/extensibility/index.md
413+
- Rules and AGENTS.md: https://docs.devin.ai/cli/extensibility/rules.md
414+
- Skills overview: https://docs.devin.ai/cli/extensibility/skills/overview.md
415+
- Skill format: https://docs.devin.ai/cli/extensibility/skills/creating-skills.md
416+
- MCP configuration: https://docs.devin.ai/cli/extensibility/mcp/configuration.md
417+
- Configuration files: https://docs.devin.ai/cli/extensibility/configuration.md
418+
372419
The generated Copilot MCP config launches both `studio mcp` and the bundled `wordpress-telemetry` MCP server through VS Code's MCP configuration.
373420

374421
The Gemini plugin is generated to:

plugins/devin/.devin/config.json

Lines changed: 18 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
name: auditing
3+
description: Audit a Studio-backed WordPress site for performance, accessibility, and visible frontend quality issues, then recommend or validate improvements.
4+
---
5+
6+
# Auditing
7+
8+
Use this skill when the user wants to review, optimize, or verify an existing WordPress site rather than primarily build new functionality.
9+
10+
## Ownership
11+
12+
This skill owns:
13+
14+
- performance audits using Studio MCP tools
15+
- accessibility-focused review of color, contrast, motion, and readability
16+
- visible frontend quality review when the user asks for QA or polish
17+
- before-and-after audit comparison after fixes
18+
19+
Use `studio` for site resolution, screenshots, and MCP tool usage details.
20+
21+
## Principle
22+
23+
Start with the smallest audit that answers the user's request.
24+
25+
- If the user asks about speed, Core Web Vitals, or performance, prioritize the performance workflow.
26+
- If the user asks about accessibility, contrast, readability, or color usage, prioritize the accessibility workflow.
27+
- If the user asks for a general review, combine the relevant sections and keep the report practical.
28+
29+
Do not invent automated checks that the available tools do not provide. When a conclusion comes from visual inspection or code reading rather than a dedicated tool, say so.
30+
31+
## Workflow
32+
33+
### 1. Resolve the target site
34+
35+
Use `studio` to:
36+
37+
- identify the site
38+
- ensure it is running
39+
- confirm the page or URL path to review
40+
41+
If the user did not specify a page, default to `/`.
42+
43+
### 2. Pick the audit scope
44+
45+
Choose one or more of:
46+
47+
- Performance Audit
48+
- Accessibility Review
49+
- Visual QA
50+
51+
Tell the user which scope you are using when it is not obvious from the request.
52+
53+
Once you begin the actual audit workflow, call `record_workflow_event` with `workflow: "auditing"` and `stage: "started"`.
54+
55+
### 3. Performance Audit
56+
57+
Use `need_for_speed` for the requested path.
58+
59+
Interpret at least:
60+
61+
- TTFB
62+
- FCP
63+
- LCP
64+
- CLS
65+
- total page weight
66+
- request count
67+
- DOM size
68+
- JS, CSS, image, and font breakdown
69+
70+
Use these baseline thresholds:
71+
72+
| Metric | Good | Needs Improvement | Poor |
73+
|-------|------|-------------------|------|
74+
| TTFB | < 800 ms | 800-1800 ms | > 1800 ms |
75+
| FCP | < 1800 ms | 1800-3000 ms | > 3000 ms |
76+
| LCP | < 2500 ms | 2500-4000 ms | > 4000 ms |
77+
| CLS | < 0.1 | 0.1-0.25 | > 0.25 |
78+
79+
Use these page-composition warning signs:
80+
81+
- DOM elements above 1500
82+
- total page weight above 3 MB
83+
- total requests above 80
84+
- scripts above 20 files or 500 KB total
85+
- stylesheets above 10 files or 200 KB total
86+
87+
Translate findings into WordPress-specific actions where possible, such as:
88+
89+
- reducing or replacing heavy plugins
90+
- deferring or removing non-critical JS
91+
- reducing oversized images
92+
- trimming unused theme CSS
93+
- checking duplicate font loads
94+
- simplifying wrapper-heavy block layouts
95+
96+
### 4. Accessibility Review
97+
98+
Use `take_screenshot` plus theme or plugin code inspection as needed.
99+
100+
Focus on issues this repo can realistically help with:
101+
102+
- low text/background contrast
103+
- weak CTA contrast or ambiguous button states
104+
- missing or unclear hover and focus states
105+
- motion that should respect `prefers-reduced-motion`
106+
- readability issues caused by font size, line height, or dense layouts
107+
- color choices that make important information hard to distinguish
108+
109+
When the issue is visual, prefer `take_screenshot`-backed observations. Use `inspect_design` when the rendered DOM or computed styles would identify the root cause faster than code inspection.
110+
111+
When the issue appears structural, inspect the relevant theme or plugin files before recommending a fix.
112+
113+
### 5. Visual QA
114+
115+
When the user wants a broader quality pass, use `take_screenshot` to check:
116+
117+
- spacing and alignment
118+
- responsive layout issues
119+
- broken visual hierarchy
120+
- inconsistent component styling
121+
- awkward cropping or media balance
122+
123+
Keep this section focused on visible problems that materially affect the site.
124+
125+
### 6. Report clearly
126+
127+
Summarize:
128+
129+
- what you audited
130+
- the most important findings
131+
- the likely causes
132+
- the highest-value next fixes
133+
134+
Prefer a short prioritized report over a long exhaustive list.
135+
136+
### 7. Re-test after changes
137+
138+
If fixes are made during the same task, re-run the relevant audit steps and compare before versus after.
139+
140+
Call out what improved, what did not, and any remaining tradeoffs.
141+
142+
When the audit workflow is complete, call `record_workflow_event` with `workflow: "auditing"` and `stage: "completed"`.
143+
144+
## Important notes
145+
146+
- `need_for_speed` results are synthetic measurements from a local Studio environment. Use them primarily for diagnosis and before-versus-after comparison, not as production truth.
147+
- Accessibility observations in this workflow are often based on visual review and code inspection rather than a dedicated automated accessibility scanner.
148+
- When performance, accessibility, and design issues conflict, explain the tradeoff instead of over-optimizing one dimension silently.

0 commit comments

Comments
 (0)