PromptPilot

What is PromptPilot about?

PromptPilot offers two core capabilities: instant creation of basic prompts from a keyword or short phrase, and a conversational "Masterful Prompt Creator" that asks guided questions to build comprehensive, high‑quality prompts for various generative AI models.

How to use PromptPilot?

1. Clone the repository

   git clone https://github.com/FelixFoster/mcp-enhance-prompt
   cd mcp-enhance-prompt
   

2. Install dependencies

   npm install
   

3. Run the server (preferred via npx):

   npx -y enhance-prompt-server
   

4. Open a browser and navigate to the frontend endpoint, e.g., http://localhost:9593/rest.

Alternative run methods include executing the built artifact with node build/index.js or using Docker.

Key Features of PromptPilot

• 🚀 Quick Prompt Generation – Input a simple keyword; receive ready‑to‑use prompt(s) instantly.
• 🧠 Guided Q&A Prompt Enhancement – Chat‑like interface that iteratively refines user requirements into a detailed prompt.
• Multi‑modal deployment – Run directly, via Docker, or with a single‑command npx execution.
• Open‑source MIT licensed – Easy to fork, extend, and integrate.

Use Cases of PromptPilot

• Rapid prototyping for developers experimenting with LLMs.
• Content creators needing structured prompts for image, text, or code generation.
• Teams standardizing prompt quality across projects.
• Educational tools teaching prompt‑engineering best practices.

FAQ from PromptPilot

Q: Do I need an API key? A: The underlying AI service (e.g., OpenAI, Anthropic) requires an API key, which should be provided via environment variables when running the server.

Q: Can I customize the prompt generation logic? A: Yes, the source code is open and modular; you can replace the AI provider or adjust the prompt templates.

Q: Is Docker required? A: No, Docker is optional. You can run the server directly with Node.js or the convenient npx command.

Q: Which ports does the server use? A: By default the server listens on port 9593, but this can be changed in the configuration files.

Q: How do I contribute? A: Fork the repository, create a feature branch, commit changes, and open a pull request following the contribution guide in the README.

PromptPilot - AI Prompt Guide & Enhancer

PromptPilot is an AI - powered web application designed to assist users in generating and enhancing prompts for various generative AI models. It offers a quick generation feature for simple needs and a unique conversational guide (Masterful Prompt Creator) for crafting high - quality, detailed prompts. This repository contains the codebase for PromptPilot.

✨ Features

This application focuses on two core functionalities:

1. 🚀 Quick Prompt Generation:

   • Accepts a simple keyword or short phrase from the user.
   • Leverages AI to generate one or more basic, ready - to - use prompts based on the input.
   • Ideal for users needing a fast starting point.

2. 🧠 Guided Q&A Prompt Enhancement :

   • Provides an interactive, chat - like interface.
   • Guides the user through a series of questions using AI.
   • Helps users articulate and refine their requirements in detail.
   • Generates a comprehensive, high - quality prompt based on the guided conversation.
   • Aims to significantly improve the relevance and quality of AI outputs.

🚀 Getting Started

Prerequisites

• Node.js and npm (or yarn) for frontend/backend (depending on your tech stack)
• Docker and Docker Compose (optional, but recommended for easier setup)

Step 1: Clone the repository

git clone https://github.com/FelixFoster/mcp-enhance-prompt # Replace with your actual repo URL
cd mcp-enhance-prompt

Step 2: Install Dependencies

Navigate into the relevant directories and install the dependencies.

npm install

Step 4: Build the Project

npm run build

Step 5: Run the Application

You have several options to run the application:

Option 1: Run Directly

node build/index.js

Option 2: Run with Docker

docker build -t enhance-prompt-server .
docker run -i --rm enhance-prompt-server

Option 3: Run with npx

npx -y enhance-prompt-server

Step 6: Access the Application

Open your web browser and navigate to the address where your frontend application is served (e.g., http://localhost:9593/rest).

🐛 Troubleshooting

• Backend Logs: Check the console logs of your backend process for error messages.
• Network Issues: Ensure your backend is running on the correct port and that there are no firewall issues blocking access. If using Docker, verify port mappings.
• Dependencies: Make sure all project dependencies were installed successfully.

🤝 Contributing

Contributions are welcome! If you'd like to contribute to PromptPilot, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your - feature).
3. Make your changes.
4. Commit your changes (git commit -am 'feat: Add new feature X').
5. Push to the branch (git push origin feature/your - feature).
6. Create a new Pull Request.

Please ensure your code follows the project's coding standards and include tests where appropriate.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.