sirchmunk 0.0.1.post1__tar.gz → 0.0.2__tar.gz

{sirchmunk-0.0.1.post1 → sirchmunk-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sirchmunk
-Version: 0.0.1.post1
+Version: 0.0.2
 Summary: Sirchmunk: From raw data to self-evolving real-time intelligence.
 Author: ModelScope Team
 Author-email: contact@modelscope.cn
@@ -34,6 +34,8 @@ Requires-Dist: tqdm
 Requires-Dist: rapidfuzz
 Requires-Dist: duckdb
 Requires-Dist: kreuzberg>=4.0.0rc1
+Requires-Dist: sentence-transformers
+Requires-Dist: modelscope
 Provides-Extra: web
 Requires-Dist: fastapi>=0.100.0; extra == "web"
 Requires-Dist: uvicorn[standard]>=0.24.0; extra == "web"
@@ -103,6 +105,7 @@ Dynamic: license-file
 [![ripgrep-all](https://img.shields.io/badge/ripgrep--all-Search-E67E22?style=flat-square&logo=rust&logoColor=white)](https://github.com/phiresky/ripgrep-all)
 [![OpenAI](https://img.shields.io/badge/OpenAI-API-412991?style=flat-square&logo=openai&logoColor=white)](https://github.com/openai/openai-python)
 [![Kreuzberg](https://img.shields.io/badge/Kreuzberg-Text_Extraction-4CAF50?style=flat-square)](https://github.com/kreuzberg-dev/kreuzberg)
+[![MCP](https://img.shields.io/badge/MCP-Python_SDK-8B5CF6?style=flat-square&logo=python&logoColor=white)](https://github.com/modelcontextprotocol/python-sdk)
 
 
 [**Quick Start**](#-quick-start) · [**Key Features**](#-key-features) · [**Web UI**](#-web-ui) · [**How it Works**](#-how-it-works) · [**FAQ**](#-faq)
@@ -228,6 +231,12 @@ It serves as a unified intelligent hub for AI agents, delivering deep insights a
 
 ## 🎉 News
 
+* 🚀 **Feb 5, 2026**: Release **v0.0.2** — MCP Support, CLI Commands & Knowledge Persistence!
+  - **MCP Integration**: Full [Model Context Protocol](https://modelcontextprotocol.io) support, works seamlessly with Claude Desktop and Cursor IDE.
+  - **CLI Commands**: New `sirchmunk` CLI with `init`, `config`, `serve`, and `search` commands.
+  - **KnowledgeCluster Persistence**: DuckDB-powered storage with Parquet export for efficient knowledge management.
+  - **Knowledge Reuse**: Semantic similarity-based cluster retrieval for faster searches via embedding vectors.
+
 * 🎉🎉 Jan 22, 2026: Introducing **Sirchmunk**: Initial Release v0.0.1 Now Available!
 
 
@@ -273,9 +282,9 @@ llm = OpenAIChat(
 
 async def main():
     
-    agent_search = AgenticSearch(llm=llm)
+    searcher = AgenticSearch(llm=llm)
     
-    result: str = await agent_search.search(
+    result: str = await searcher.search(
         query="How does transformer attention work?",
         search_paths=["/path/to/documents"],
     )
@@ -286,11 +295,117 @@ asyncio.run(main())
 ```
 
 **⚠️ Notes:**
-- Upon initialization, AgenticSearch automatically checks if ripgrep-all and ripgrep are installed. If they are missing, it will attempt to install them automatically. If the automatic installation fails, please install them manually.
+- Upon initialization, `AgenticSearch` automatically checks if `ripgrep-all` and `ripgrep` are installed. If they are missing, it will attempt to install them automatically. If the automatic installation fails, please install them manually.
   - References: https://github.com/BurntSushi/ripgrep | https://github.com/phiresky/ripgrep-all
 - Replace `"your-api-key"`, `"your-base-url"`, `"your-model-name"` and `/path/to/documents` with your actual values.
 
 
+### Command Line Interface
+
+Sirchmunk provides a powerful CLI for server management and search operations.
+
+#### Installation
+
+```bash
+pip install "sirchmunk[web]"
+
+# or install via UV
+uv pip install "sirchmunk[web]"
+```
+
+
+#### Initialize
+
+```bash
+# Initialize Sirchmunk with default settings (Default work path: `~/.sirchmunk/`)
+sirchmunk init
+
+# Alternatively, initialize with custom work path
+sirchmunk init --work-path /path/to/workspace
+```
+
+#### Configure
+
+```bash
+# Show current configuration
+sirchmunk config
+
+# Regenerate configuration file if needed (Default config file: ~/.sirchmunk/.env)
+sirchmunk config --generate
+```
+
+#### Start API Server
+
+```bash
+# Start server with default settings
+sirchmunk serve
+
+# Custom host and port
+sirchmunk serve --host 0.0.0.0 --port 8000
+
+# Development mode with auto-reload
+sirchmunk serve --reload
+```
+
+#### Search
+
+```bash
+# Search in current directory
+sirchmunk search "How does authentication work?"
+
+# Search in specific paths
+sirchmunk search "find all API endpoints" ./src ./docs
+
+# Quick filename search
+sirchmunk search "config" --mode FILENAME_ONLY
+
+# Output as JSON
+sirchmunk search "database schema" --output json
+
+# Use API server (requires running server)
+sirchmunk search "query" --api --api-url http://localhost:8584
+```
+
+#### Available Commands
+
+| Command | Description |
+|---------|-------------|
+| `sirchmunk init` | Initialize working directory and configuration |
+| `sirchmunk config` | Show or generate configuration |
+| `sirchmunk serve` | Start the API server |
+| `sirchmunk search` | Perform search queries |
+| `sirchmunk version` | Show version information |
+
+---
+
+## 🔌 MCP Server
+
+Sirchmunk provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that exposes its intelligent search capabilities as MCP tools. This enables seamless integration with AI assistants like **Claude Desktop** and **Cursor IDE**.
+
+### Quick Start
+
+```bash
+# Install MCP package
+pip install sirchmunk-mcp
+
+# Initialize and configure
+sirchmunk-mcp init
+sirchmunk-mcp config --generate
+
+# Edit ~/.sirchmunk/.mcp_env with your LLM API key
+
+# Test with MCP Inspector
+npx @modelcontextprotocol/inspector sirchmunk-mcp serve
+```
+
+### Features
+
+- **Multi-Mode Search**: DEEP mode for comprehensive analysis, FILENAME_ONLY for fast file discovery
+- **Knowledge Cluster Management**: Automatic extraction, storage, and reuse of knowledge
+- **Standard MCP Protocol**: Works with stdio and Streamable HTTP transports
+
+📖 **For detailed documentation, see [Sirchmunk MCP README](src/sirchmunk_mcp/README.md)**.
+
 ---
 
 ## 🖥️ Web UI
@@ -364,10 +479,10 @@ python scripts/stop_web.py
 
 ### Data Storage
 
-All persistent data is stored in the configured `WORK_PATH` (default: `~/.sirchmunk/`):
+All persistent data is stored in the configured `SIRCHMUNK_WORK_PATH` (default: `~/.sirchmunk/`):
 
 ```
-{WORK_PATH}/
+{SIRCHMUNK_WORK_PATH}/
   ├── .cache/
     ├── history/              # Chat session history (DuckDB)
     │   └── chat_history.db
@@ -410,7 +525,7 @@ Any OpenAI-compatible API endpoint, including (but not limited too):
 Simply specify the path in your search query:
 
 ```python
-result = await search.search(
+result = await searcher.search(
     query="Your question",
     search_paths=["/path/to/folder", "/path/to/file.pdf"]
 )
@@ -425,7 +540,7 @@ No pre-processing or indexing required!
 
 Knowledge clusters are persisted in Parquet format at:
 ```
-{WORK_PATH}/.cache/knowledge/knowledge_clusters.parquet
+{SIRCHMUNK_WORK_PATH}/.cache/knowledge/knowledge_clusters.parquet
 ```
 
 You can query them using DuckDB or the `KnowledgeManager` API.
@@ -437,7 +552,7 @@ You can query them using DuckDB or the `KnowledgeManager` API.
 
 1. **Web Dashboard**: Visit the Monitor page for real-time statistics
 2. **API**: `GET /api/v1/monitor/llm` returns usage metrics
-3. **Code**: Access `search.llm_usages` after search completion
+3. **Code**: Access `searcher.llm_usages` after search completion
 
 </details>
 

{sirchmunk-0.0.1.post1 → sirchmunk-0.0.2}/README.md

@@ -13,6 +13,7 @@
 [![ripgrep-all](https://img.shields.io/badge/ripgrep--all-Search-E67E22?style=flat-square&logo=rust&logoColor=white)](https://github.com/phiresky/ripgrep-all)
 [![OpenAI](https://img.shields.io/badge/OpenAI-API-412991?style=flat-square&logo=openai&logoColor=white)](https://github.com/openai/openai-python)
 [![Kreuzberg](https://img.shields.io/badge/Kreuzberg-Text_Extraction-4CAF50?style=flat-square)](https://github.com/kreuzberg-dev/kreuzberg)
+[![MCP](https://img.shields.io/badge/MCP-Python_SDK-8B5CF6?style=flat-square&logo=python&logoColor=white)](https://github.com/modelcontextprotocol/python-sdk)
 
 
 [**Quick Start**](#-quick-start) · [**Key Features**](#-key-features) · [**Web UI**](#-web-ui) · [**How it Works**](#-how-it-works) · [**FAQ**](#-faq)
@@ -138,6 +139,12 @@ It serves as a unified intelligent hub for AI agents, delivering deep insights a
 
 ## 🎉 News
 
+* 🚀 **Feb 5, 2026**: Release **v0.0.2** — MCP Support, CLI Commands & Knowledge Persistence!
+  - **MCP Integration**: Full [Model Context Protocol](https://modelcontextprotocol.io) support, works seamlessly with Claude Desktop and Cursor IDE.
+  - **CLI Commands**: New `sirchmunk` CLI with `init`, `config`, `serve`, and `search` commands.
+  - **KnowledgeCluster Persistence**: DuckDB-powered storage with Parquet export for efficient knowledge management.
+  - **Knowledge Reuse**: Semantic similarity-based cluster retrieval for faster searches via embedding vectors.
+
 * 🎉🎉 Jan 22, 2026: Introducing **Sirchmunk**: Initial Release v0.0.1 Now Available!
 
 
@@ -183,9 +190,9 @@ llm = OpenAIChat(
 
 async def main():
     
-    agent_search = AgenticSearch(llm=llm)
+    searcher = AgenticSearch(llm=llm)
     
-    result: str = await agent_search.search(
+    result: str = await searcher.search(
         query="How does transformer attention work?",
         search_paths=["/path/to/documents"],
     )
@@ -196,11 +203,117 @@ asyncio.run(main())
 ```
 
 **⚠️ Notes:**
-- Upon initialization, AgenticSearch automatically checks if ripgrep-all and ripgrep are installed. If they are missing, it will attempt to install them automatically. If the automatic installation fails, please install them manually.
+- Upon initialization, `AgenticSearch` automatically checks if `ripgrep-all` and `ripgrep` are installed. If they are missing, it will attempt to install them automatically. If the automatic installation fails, please install them manually.
   - References: https://github.com/BurntSushi/ripgrep | https://github.com/phiresky/ripgrep-all
 - Replace `"your-api-key"`, `"your-base-url"`, `"your-model-name"` and `/path/to/documents` with your actual values.
 
 
+### Command Line Interface
+
+Sirchmunk provides a powerful CLI for server management and search operations.
+
+#### Installation
+
+```bash
+pip install "sirchmunk[web]"
+
+# or install via UV
+uv pip install "sirchmunk[web]"
+```
+
+
+#### Initialize
+
+```bash
+# Initialize Sirchmunk with default settings (Default work path: `~/.sirchmunk/`)
+sirchmunk init
+
+# Alternatively, initialize with custom work path
+sirchmunk init --work-path /path/to/workspace
+```
+
+#### Configure
+
+```bash
+# Show current configuration
+sirchmunk config
+
+# Regenerate configuration file if needed (Default config file: ~/.sirchmunk/.env)
+sirchmunk config --generate
+```
+
+#### Start API Server
+
+```bash
+# Start server with default settings
+sirchmunk serve
+
+# Custom host and port
+sirchmunk serve --host 0.0.0.0 --port 8000
+
+# Development mode with auto-reload
+sirchmunk serve --reload
+```
+
+#### Search
+
+```bash
+# Search in current directory
+sirchmunk search "How does authentication work?"
+
+# Search in specific paths
+sirchmunk search "find all API endpoints" ./src ./docs
+
+# Quick filename search
+sirchmunk search "config" --mode FILENAME_ONLY
+
+# Output as JSON
+sirchmunk search "database schema" --output json
+
+# Use API server (requires running server)
+sirchmunk search "query" --api --api-url http://localhost:8584
+```
+
+#### Available Commands
+
+| Command | Description |
+|---------|-------------|
+| `sirchmunk init` | Initialize working directory and configuration |
+| `sirchmunk config` | Show or generate configuration |
+| `sirchmunk serve` | Start the API server |
+| `sirchmunk search` | Perform search queries |
+| `sirchmunk version` | Show version information |
+
+---
+
+## 🔌 MCP Server
+
+Sirchmunk provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that exposes its intelligent search capabilities as MCP tools. This enables seamless integration with AI assistants like **Claude Desktop** and **Cursor IDE**.
+
+### Quick Start
+
+```bash
+# Install MCP package
+pip install sirchmunk-mcp
+
+# Initialize and configure
+sirchmunk-mcp init
+sirchmunk-mcp config --generate
+
+# Edit ~/.sirchmunk/.mcp_env with your LLM API key
+
+# Test with MCP Inspector
+npx @modelcontextprotocol/inspector sirchmunk-mcp serve
+```
+
+### Features
+
+- **Multi-Mode Search**: DEEP mode for comprehensive analysis, FILENAME_ONLY for fast file discovery
+- **Knowledge Cluster Management**: Automatic extraction, storage, and reuse of knowledge
+- **Standard MCP Protocol**: Works with stdio and Streamable HTTP transports
+
+📖 **For detailed documentation, see [Sirchmunk MCP README](src/sirchmunk_mcp/README.md)**.
+
 ---
 
 ## 🖥️ Web UI
@@ -274,10 +387,10 @@ python scripts/stop_web.py
 
 ### Data Storage
 
-All persistent data is stored in the configured `WORK_PATH` (default: `~/.sirchmunk/`):
+All persistent data is stored in the configured `SIRCHMUNK_WORK_PATH` (default: `~/.sirchmunk/`):
 
 ```
-{WORK_PATH}/
+{SIRCHMUNK_WORK_PATH}/
   ├── .cache/
     ├── history/              # Chat session history (DuckDB)
     │   └── chat_history.db
@@ -320,7 +433,7 @@ Any OpenAI-compatible API endpoint, including (but not limited too):
 Simply specify the path in your search query:
 
 ```python
-result = await search.search(
+result = await searcher.search(
     query="Your question",
     search_paths=["/path/to/folder", "/path/to/file.pdf"]
 )
@@ -335,7 +448,7 @@ No pre-processing or indexing required!
 
 Knowledge clusters are persisted in Parquet format at:
 ```
-{WORK_PATH}/.cache/knowledge/knowledge_clusters.parquet
+{SIRCHMUNK_WORK_PATH}/.cache/knowledge/knowledge_clusters.parquet
 ```
 
 You can query them using DuckDB or the `KnowledgeManager` API.
@@ -347,7 +460,7 @@ You can query them using DuckDB or the `KnowledgeManager` API.
 
 1. **Web Dashboard**: Visit the Monitor page for real-time statistics
 2. **API**: `GET /api/v1/monitor/llm` returns usage metrics
-3. **Code**: Access `search.llm_usages` after search completion
+3. **Code**: Access `searcher.llm_usages` after search completion
 
 </details>
 

{sirchmunk-0.0.1.post1 → sirchmunk-0.0.2}/requirements/core.txt

@@ -13,3 +13,5 @@ tqdm
 rapidfuzz
 duckdb
 kreuzberg>=4.0.0rc1
+sentence-transformers
+modelscope