Skip to content

docs: add AI generated conceptual visualization to README #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OgeonX-Ai merged 4 commits into from
Jul 13, 2026
+21 −9
Merged

docs: add AI generated conceptual visualization to README #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e85554a
feat(promptimprover): add swarm dashboard tooling and package manifest
Aitomates Jul 6, 2026
26ae34d
fix: bind dashboard to loopback-only and escape HTML in trace renderi…
Aitomates Jul 6, 2026
d5b9a33
docs: add AI generated conceptual visualization to README
Aitomates Jul 11, 2026
cb0315f
Merge remote-tracking branch 'origin/master' into merge-train/pi-33
Aitomates Jul 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,30 @@
# PromptImprover
# ?? Promptimprover: MCP-First Prompt Governance

[![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)
![Visual Diagram](docs/assets/concept.png)


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

Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) ecosystem:
[gsd-orchestrator](https://github.com/Coding-Autopilot-System/gsd-orchestrator) | [autogen](https://github.com/Coding-Autopilot-System/autogen)
**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.

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

This repository is strongest as a portfolio demonstration of three ideas:
## ? Quickstart
1. Ensure Node 22 is installed.
2. Build the MCP Server:
\\\ash
npm install && npm run build
\\\
3. Link to your MCP client:
\\\ash
npm run link-mcp
Comment on lines +22 to +26

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 11, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use setup commands that actually exist

For a fresh checkout following this Quickstart from the repo root, npm run build fails because the root package.json added in this change only defines dashboard and dashboard-web, and there is no link-mcp script anywhere in the repo. This makes the primary setup path in the README unusable; it should either point to the existing installer/universal-refiner package commands or add the advertised scripts.

Useful? React with 👍 / 👎.

\\\

- prompt governance before code execution
- MCP-based integration instead of editor-specific glue
Expand Down
Binary file added docs/assets/concept.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.