|
1 | | -# PromptImprover: Universal AI Governance & Refinement |
2 | | -**Enterprise-Grade MCP Server for Intelligent Prompt Engineering** |
3 | | - |
4 | | -## 🚀 Overview |
5 | | -PromptImprover is a centralized middleware layer built using the **Model Context Protocol (MCP)**. It ensures that every instruction sent to an AI Agent (Claude, Gemini, Codex) is automatically refined to follow modern engineering standards (SOLID, SRP, OWASP) before code generation begins. |
6 | | - |
7 | | -## 🛠️ Key Features |
8 | | -- **Neural Snippets (RAG)**: Automatically retrieves relevant code examples from your local codebase to ensure style consistency. |
9 | | -- **Compounding Memory**: A persistent local "Brain" that learns project-specific rules and history over time. |
10 | | -- **Auto-Heal Middleware**: Intercepts tool errors and autonomously fixes them using a specialist "Healer" agent. |
11 | | -- **Context-Aware Scouting**: Automatically detects tech stacks (Node, Python, Go) and architectural patterns. |
12 | | -- **Robust Commit Tracking**: Dynamically fetches and correlates gapless repository history. |
13 | | -- **Agent Output Logging**: Tracks the final outcome of agent executions via unique Prompt IDs. |
14 | | - |
15 | | -## 📦 Project Structure |
16 | | -- `/universal-refiner`: The core MCP server and Gemini CLI extension. |
17 | | -- `/archive`: Deprecated versions and old server logic. |
18 | | - |
19 | | -## 📥 Installation |
20 | | -To install the refiner globally on your machine: |
21 | | -1. Run `.\build_and_install.ps1` from the root. |
22 | | -2. Add to your AI tool (Claude/Cursor) as an MCP server with the command `prompt-refiner`. |
23 | | - |
24 | | -## 📄 Compliance |
25 | | -This project is designed to align with **ISO 27001** standards for secure software development and AI governance. |
| 1 | +# Promptimprover |
| 2 | + |
| 3 | +[](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/ci.yml) |
| 4 | +[](https://nodejs.org/) |
| 5 | +[](LICENSE) |
| 6 | + |
| 7 | +Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) ecosystem: |
| 8 | +[gsd-orchestrator](https://github.com/Coding-Autopilot-System/gsd-orchestrator) | [autogen](https://github.com/Coding-Autopilot-System/autogen) |
| 9 | + |
| 10 | +Promptimprover is an MCP server middleware that intercepts and refines every AI prompt before code generation — applying project context, coding standards, and compounding memory. |
| 11 | + |
| 12 | +## Features |
| 13 | + |
| 14 | +- **RAG neural snippets** — FlexSearch-based retrieval over the local codebase; injects relevant code examples into every prompt |
| 15 | +- **Compounding memory** — SQLite-backed pattern store accumulates project-specific rules and standards learned over time |
| 16 | +- **Auto-heal middleware** — background file watcher triggers commit ingestion and lesson extraction; keeps context current without manual intervention |
| 17 | +- **Context-aware project scouting** — NodeDetector, PythonDetector, and ArchitecturalScout identify tech stack and patterns at startup |
| 18 | + |
| 19 | +## Architecture |
| 20 | + |
| 21 | +```mermaid |
| 22 | +flowchart LR |
| 23 | + CLI["AI CLI\n(Claude / Cursor)"] -->|"stdio"| PI["Promptimprover\n(prompt-refiner)"] |
| 24 | + subgraph internal["Promptimprover Engine"] |
| 25 | + RAG["RAG Snippets\n(FlexSearch)"] |
| 26 | + Memory["SQLite Memory\n(LocalBrain)"] |
| 27 | + AutoHeal["Auto-Heal\n(BackgroundService)"] |
| 28 | + end |
| 29 | + PI --> RAG |
| 30 | + PI --> Memory |
| 31 | + PI --> AutoHeal |
| 32 | + internal --> Out["Augmented Prompt"] |
| 33 | +``` |
| 34 | + |
| 35 | +## Quickstart |
| 36 | + |
| 37 | +```powershell |
| 38 | +git clone https://github.com/Coding-Autopilot-System/Promptimprover.git |
| 39 | +cd Promptimprover |
| 40 | +.\build_and_install.ps1 |
| 41 | +``` |
| 42 | + |
| 43 | +Add `prompt-refiner` to your MCP client configuration. See the [Setup Guide](https://github.com/Coding-Autopilot-System/Promptimprover/wiki/Setup-Guide) for full configuration instructions. |
| 44 | + |
| 45 | +## License |
| 46 | + |
| 47 | +MIT — see [LICENSE](LICENSE) |
0 commit comments