Skip to content

Commit f2df094

Browse files
committed
docs: sharpen portfolio proof
1 parent 0e4e021 commit f2df094

2 files changed

Lines changed: 58 additions & 10 deletions

File tree

README.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Promptimprover
1+
# PromptImprover
22

33
[![CI](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/ci.yml)
44
[![Node 22](https://img.shields.io/badge/node-22-brightgreen)](https://nodejs.org/)
@@ -7,21 +7,43 @@
77
Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) ecosystem:
88
[gsd-orchestrator](https://github.com/Coding-Autopilot-System/gsd-orchestrator) | [autogen](https://github.com/Coding-Autopilot-System/autogen)
99

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.
10+
PromptImprover is an MCP-first prompt governance layer for engineering workflows. It sits between an AI client and execution tools, adds repo-aware context, applies prompt refinement rules, and records evidence that can be used to improve future runs.
11+
12+
This repository is strongest as a portfolio demonstration of three ideas:
13+
14+
- prompt governance before code execution
15+
- MCP-based integration instead of editor-specific glue
16+
- evidence-backed refinement using history, tests, and repo context
17+
18+
## What It Demonstrates
19+
20+
- **MCP integration**: the active implementation is the `universal-refiner` package, a TypeScript MCP server for cross-CLI prompt refinement
21+
- **Governance pipeline**: prompts can be captured, classified, refined, and linked to execution outcomes instead of being treated as disposable chat
22+
- **Repo-aware context**: detectors, memory, and retrieval components adapt refinement to the current codebase
23+
- **Proof-oriented design**: tests and architecture docs emphasize traceability, learning, and operational visibility rather than prompt rewriting alone
1124

1225
## Features
1326

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
27+
- **RAG snippets**: FlexSearch-based retrieval over the local codebase to inject relevant examples into prompt refinement
28+
- **Persistent memory**: SQLite-backed storage for reusable rules, learned patterns, and prompt history
29+
- **Context scouting**: detectors identify language, framework, and architectural signals at startup
30+
- **Operational traceability**: history, timelines, and prompt-to-outcome correlation are first-class design goals
31+
32+
## Current Scope vs. Roadmap
1833

19-
## Architecture
34+
The repo contains both implemented components and forward-looking architecture.
35+
36+
- **Implemented now**: the `universal-refiner` MCP server, Gemini-oriented packaging, tests, and install/build scripts
37+
- **Designed for later expansion**: broader routing, portal, and evidence workflows described in the architecture spec
38+
39+
That distinction matters because this repo is about credible system direction, not vague AI middleware claims.
40+
41+
## Architecture Snapshot
2042

2143
```mermaid
2244
flowchart LR
23-
CLI["AI CLI\n(Claude / Cursor)"] -->|"stdio"| PI["Promptimprover\n(prompt-refiner)"]
24-
subgraph internal["Promptimprover Engine"]
45+
CLI["AI CLI\n(Claude / Cursor)"] -->|"stdio"| PI["PromptImprover\n(prompt-refiner)"]
46+
subgraph internal["PromptImprover Engine"]
2547
RAG["RAG Snippets\n(FlexSearch)"]
2648
Memory["SQLite Memory\n(LocalBrain)"]
2749
AutoHeal["Auto-Heal\n(BackgroundService)"]
@@ -32,6 +54,13 @@ flowchart LR
3254
internal --> Out["Augmented Prompt"]
3355
```
3456

57+
## Proof Points
58+
59+
- [Portfolio proof notes](./docs/portfolio-proof.md)
60+
- [Architecture spec](./docs/promptimprover-autogen-architecture-spec.md)
61+
- [`universal-refiner/package.json`](./universal-refiner/package.json)
62+
- [`universal-refiner/tests`](./universal-refiner/tests)
63+
3564
## Quickstart
3665

3766
```powershell
@@ -44,4 +73,4 @@ Add `prompt-refiner` to your MCP client configuration. See the [Setup Guide](htt
4473

4574
## License
4675

47-
MIT see [LICENSE](LICENSE)
76+
MIT - see [LICENSE](LICENSE)

docs/portfolio-proof.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Portfolio Proof Notes
2+
3+
This repo is best read as an enterprise-oriented MCP and prompt-governance prototype, not as a generic prompt helper.
4+
5+
## Present-State Evidence
6+
7+
- `universal-refiner/package.json` defines the active package as `gemini-prompt-refiner` and describes it as cross-CLI prompt refinement using an MCP server.
8+
- `universal-refiner/tests/` contains targeted Vitest coverage for detectors, history, lessons, memory, snippets, predictive refinement, timeline behavior, and server behavior.
9+
- `build_and_install.ps1` installs the `universal-refiner` package globally as `prompt-refiner`, showing the intended operator entry point.
10+
11+
## Governance Signal
12+
13+
- The root `context.md` makes traceability and post-change verification explicit project mandates.
14+
- `universal-refiner/AGENTS.md` requires MCP-first workflow for non-trivial repo work and treats prompt activity as durable operational history.
15+
- The architecture spec defines prompts as governed artifacts that should be captured, classified, routed, and linked to outcomes.
16+
17+
## Roadmap Boundary
18+
19+
The strongest implemented proof is the MCP refinement server and its tests. Broader portal, dispatch, and evidence workflows are documented direction in [promptimprover-autogen-architecture-spec.md](./promptimprover-autogen-architecture-spec.md), not all fully realized product surface today.

0 commit comments

Comments
 (0)