diff --git a/README.md b/README.md index 82241b4..256f003 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,64 @@ -# prompt-optimizer +# Prompt Optimizer -MPM Prompt Optimizer — Claude CoWork plugin that transforms rough requests into optimized, well-structured prompts. Conducts an adaptive interview, invokes the right skills automatically, and delivers a polished prompt ready to run. \ No newline at end of file +A Claude CoWork plugin for the MPM team that transforms rough requests into precise, well-structured prompts — getting dramatically better results from Claude with less trial and error. + +## What It Does + +When you have an idea but aren't sure how to ask Claude for it, the Prompt Optimizer steps in. It: + +1. **Asks how experienced you are** with Claude prompting — and calibrates how many questions it asks based on your answer (beginners get more guidance; advanced users get a faster, lighter-touch experience) +2. **Interviews you** with just the right questions to fill in what's missing — audience, context, format, constraints +3. **Automatically selects the right skills** — if you need a Word doc, it invokes the docx skill; a presentation, the pptx skill; branded content, the MPM brand voice skill — all woven in naturally +4. **Shows you the optimized prompt** for review before running anything, with a clear explanation of what was improved +5. **Saves the optimized prompt** as a downloadable `.md` file so you can reuse it anytime +6. **Executes immediately** once you approve + +## How to Use It + +Just say any of the following: +- "Optimize this prompt: [your rough idea]" +- "Help me ask this better: [your request]" +- "I'm not getting what I want from Claude — help me improve my prompt" +- "Prompt optimizer" +- "Make this clearer for Claude: [text]" + +## Skill + +| Skill | What it does | +|---|---| +| `optimize-prompt` | Full optimization workflow — interview, rewrite, review, save, execute | + +## Skills Integrated + +The optimizer is aware of all MPM skills and will automatically include the right ones: + +- `docx` — Word documents +- `pptx` — Presentations and slide decks +- `xlsx` — Spreadsheets +- `pdf` — PDF creation and manipulation +- `mpm-brand-voice:brand-voice-enforcement` — On-brand content +- `odoo-mpm:odoo` — MPM business data lookups +- `display-catalog:display-catalog` — MPM product specs (preferred source; falls back to Odoo) + +## Important: MPM Product Specs + +MPM manufactures all its own displays. The optimizer will never direct Claude to search the web for MPM product specifications — all spec lookups use internal sources only (Display Catalog skill or Odoo). + +## Installation + +Install via the Plugins panel in Claude CoWork. + +## Repository Structure + +``` +prompt-optimizer/ +├── .claude-plugin/ +│ └── plugin.json # Plugin manifest +├── skills/ +│ └── optimize-prompt/ +│ ├── SKILL.md # Main skill — full optimization workflow +│ └── references/ +│ ├── optimization-guide.md # Prompt writing best practices & examples +│ └── skill-awareness.md # Skill trigger map & MPM product rules +└── README.md +```