From 57620a45b3071e641c28e7a15ba00de9db9e4e77 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Sun, 30 Nov 2025 16:05:27 +0000
Subject: [PATCH 1/2] Initial plan
From c6b4b38cd419e2e9f8b7ca93f9c0430518d1a265 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Sun, 30 Nov 2025 16:09:36 +0000
Subject: [PATCH 2/2] docs: Revamp README for clarity, onboarding, and
community growth
Co-authored-by: wspotter <125415284+wspotter@users.noreply.github.com>
---
README.md | 172 +++++++++++++-----------------------------------------
1 file changed, 41 insertions(+), 131 deletions(-)
diff --git a/README.md b/README.md
index 8f9c2a7..554e1cd 100644
--- a/README.md
+++ b/README.md
@@ -15,10 +15,31 @@
[π Quick Start](#-quick-start) β’ [π Documentation](QUICKSTART.md) β’ [π Report Bug](https://github.com/wspotter/mcpower/issues) β’ [π‘ Request Feature](https://github.com/wspotter/mcpower/issues)
- ---
-
+---
+
+## β Spread the Word
+
+If you find MCPower useful, help us grow the community!
+
+
+
+**[β Star this repo](https://github.com/wspotter/mcpower)** to show your support!
+
+Share MCPower: [Twitter/X](https://twitter.com/intent/tweet?text=Check%20out%20MCPower%20-%20Semantic%20Knowledge%20Search%20with%20FAISS%20%26%20MCP!&url=https://github.com/wspotter/mcpower) β’ [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/wspotter/mcpower) β’ [Reddit](https://reddit.com/submit?url=https://github.com/wspotter/mcpower&title=MCPower%20-%20Semantic%20Knowledge%20Search%20with%20FAISS%20%26%20MCP)
+
+
+
+---
+
+## π Project Status
+
+- β
**Phase 1-5**: Complete (All user stories implemented)
+- π§ **Phase 6**: Polish & documentation (in progress)
+
+---
+
## β¨ What is MCPower?
MCPower is a **Model Context Protocol (MCP) server** that provides powerful semantic search over your document collections. Drop in any folder of `.txt` or `.md` files, and get instant AI-powered search capabilities through a beautiful web interface or programmatic API.
@@ -65,8 +86,6 @@ Modern, responsive web console with real-time stats and visual feedback.
---
----
-
## π Quick Start
@@ -104,6 +123,7 @@ Your browser opens automatically to **http://127.0.0.1:4173** π
### πΈ What You'll See
+
Drag & drop folders, browse for directories, or type paths manually
---
-β βββββββ¬ββββββ β
-ββββββββββΌβββββββββ
- β execa (JSON over stdio)
- β
-ββββββββββ΄βββββββββ
-β Python Bridge β
-β (Python) β
-β β
-β βββββββββββββ β
-β β FAISS β β Vector search
-β β Index β β
-β βββββββββββββ β
-β β
-β βββββββββββββ β
-β β Sentence β β Query encoding
-β βTransformersβ β
-β βββββββββββββ β
-βββββββββββββββββββ
-```
-
-## π¦ Installation
-
-### Prerequisites
-
-- **Node.js**: 18.x or higher
-- **Python**: 3.10 or higher
-- **npm**: 9.x or higher
-
-### From Source
-
-```bash
-# Clone the repository
-git clone https://github.com/yourusername/mcpower.git
-cd mcpower
-
-# Install dependencies
-npm install
-cd python && pip install -r requirements.txt && cd ..
-
-# Build
-npm run build
-
-# Optional: Link globally
-npm link
-```
-
-### Verify Installation
-
-```bash
-npm run dev -- --version
-# Output: Starting MCP Knowledge Server v0.1.0...
-```
## βοΈ Configuration
@@ -381,52 +349,8 @@ POST /api/datasets
```
---
-βββ your-dataset/
- βββ manifest.json # Configuration
- βββ metadata.json # Document metadata
- βββ index/ # FAISS index directory
- βββ docs.index # FAISS index file
-```
-
-### Manifest Format
-
-`manifest.json`:
-```json
-{
- "id": "your-dataset",
- "name": "Your Dataset Name",
- "description": "Description of your dataset",
- "index": "index",
- "metadata": "metadata.json",
- "defaultTopK": 5
-}
-```
-### Metadata Format
-
-`metadata.json`:
-```json
-[
- {
- "id": "doc-1",
- "title": "Document Title",
- "path": "path/to/document.md",
- "content": "Full document content...",
- "snippet": "Short excerpt..."
- }
-]
-```
-
-### Creating a Dataset
-
-See the [sample dataset](datasets/sample-docs/) for a complete example.
-
-To create embeddings from your documents, use a tool like:
-- [sentence-transformers](https://www.sbert.net/)
-- FAISS for indexing
-- Custom embedding pipeline
-
-## οΏ½ MCP Integration
+## π MCP Integration
MCPower works with any MCP-compatible client. Here's how to connect it:
@@ -726,6 +650,8 @@ This shows:
## π€ Contributing
+**π¨ We're actively looking for contributors!** Check out our [good first issues](https://github.com/wspotter/mcpower/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [help wanted](https://github.com/wspotter/mcpower/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) labels.
+
We welcome contributions! Here's how to get started:
### Quick Start
@@ -753,7 +679,9 @@ git commit -m "feat: add amazing feature"
git push origin feature/amazing-feature
```
-### Areas We Need Help
+### π₯ Areas We Need Help
+
+We're especially looking for contributors in these areas:
- π¨ **UI/UX**: Improve web console design
- π **Documentation**: Tutorials, examples, guides
@@ -790,6 +718,17 @@ Built with amazing open-source tools:
---
+## β Getting Help
+
+Need assistance? We're here to help!
+
+- **π Bug Reports**: [Open an issue](https://github.com/wspotter/mcpower/issues/new?labels=bug)
+- **π‘ Feature Requests**: [Request a feature](https://github.com/wspotter/mcpower/issues/new?labels=enhancement)
+- **β Questions**: [Search existing issues](https://github.com/wspotter/mcpower/issues) or open a new one
+- **π Documentation**: Check our [Quick Start Guide](QUICKSTART.md)
+
+---
+
**[β Star this repo](https://github.com/wspotter/mcpower)** if you find it useful!
@@ -799,32 +738,3 @@ Made with β€οΈ by the MCPower team
[π Report Bug](https://github.com/wspotter/mcpower/issues) β’ [β¨ Request Feature](https://github.com/wspotter/mcpower/issues) β’ [π Documentation](QUICKSTART.md)
-
-Look for error logs with:
-- `manifestPath`: Location of problematic manifest
-- `errorType`: Type of error (json_parse_error, file_not_found, validation_error)
-- `error`: Detailed error message
-
-## π License
-
-ISC
-
-## π€ Contributing
-
-Contributions welcome! Please read our contributing guidelines before submitting PRs.
-
-## π Links
-
-- [MCP Protocol Documentation](https://modelcontextprotocol.io)
-- [Quick Start Guide](specs/001-mcp-server-core/quickstart.md)
-- [API Documentation](specs/001-mcp-server-core/contracts/)
-- [Design Documents](specs/001-mcp-server-core/)
-
-## π Project Status
-
-- β
Phase 1-5: Complete (All user stories implemented)
-- π§ Phase 6: Polish & documentation (in progress)
-
----
-
-**Made with β€οΈ for the MCP community**