Skip to content

Commit 7b8b330

Browse files
OgeonX-AiAitomates
andauthored
docs: add AI generated conceptual visualization to README (#33)
* feat(promptimprover): add swarm dashboard tooling and package manifest - dashboard/View-SwarmDashboard.ps1: console-based live tail of trace log (C:\PersonalRepo\.planning\traces.jsonl), refreshed every 2s - dashboard/server.js: minimal Node HTTP server serving dashboard/index.html and a /data endpoint that streams the last 20 trace log entries as JSON - dashboard/index.html: browser table view polling /data every 2s to render swarm run traces (time, span, persona, action, tokens, reasoning) - package.json: manifest exposing `dashboard` (PowerShell) and `dashboard-web` (Node server) npm scripts - run-dashboard.ps1: entry point that launches View-SwarmDashboard.ps1 * fix: bind dashboard to loopback-only and escape HTML in trace rendering to prevent data exposure and XSS * docs: add AI generated conceptual visualization to README --------- Co-authored-by: Kim Harjamäki <kim.harjamaki@prosimo.fi>
1 parent cb7d956 commit 7b8b330

2 files changed

Lines changed: 21 additions & 9 deletions

File tree

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,30 @@
1-
# PromptImprover
1+
# ?? Promptimprover: MCP-First Prompt Governance
22

3-
[![CI](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/ci.yml/badge.svg)](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/ci.yml) [![CodeQL](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/codeql.yml/badge.svg)](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/codeql.yml)
3+
![Visual Diagram](docs/assets/concept.png)
44

55

6-
[![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)
7-
[![Node 22](https://img.shields.io/badge/node-22-brightgreen)](https://nodejs.org/)
8-
[![MIT License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)
6+
![Build Status](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/ci.yml/badge.svg)
7+
![CodeQL](https://github.com/Coding-Autopilot-System/Promptimprover/actions/workflows/codeql.yml/badge.svg)
8+
![Node 22](https://img.shields.io/badge/node-22-brightgreen)
9+
![Version](https://img.shields.io/badge/version-3.0.0--elite-blue)
910

10-
Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) ecosystem:
11-
[gsd-orchestrator](https://github.com/Coding-Autopilot-System/gsd-orchestrator) | [autogen](https://github.com/Coding-Autopilot-System/autogen)
11+
**Promptimprover** is an elite Model Context Protocol (MCP) server that acts as an intelligent prompt governance layer. It intercepts, classifies, and refines raw engineering prompts using deep repository context before they ever reach an LLM, ensuring maximum execution success.
1212

13-
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.
13+
## ?? Elite Features
14+
* **Universal Refiner MCP**: Runs cross-CLI and editor-agnostic via the official MCP specification.
15+
* **Intelligent Governance**: Evaluates raw prompts against past failures and auto-injects missing context.
16+
* **Zero-Knowledge Evidence Engine**: Tracks execution outcomes and uses RLAIF (Reinforcement Learning from AI Feedback) to refine prompts dynamically.
1417

15-
This repository is strongest as a portfolio demonstration of three ideas:
18+
## ? Quickstart
19+
1. Ensure Node 22 is installed.
20+
2. Build the MCP Server:
21+
\\\ash
22+
npm install && npm run build
23+
\\\
24+
3. Link to your MCP client:
25+
\\\ash
26+
npm run link-mcp
27+
\\\
1628

1729
- prompt governance before code execution
1830
- MCP-based integration instead of editor-specific glue

docs/assets/concept.png

1.12 MB
Loading

0 commit comments

Comments
 (0)