Omnispindle

🚀 Fast MCP Todo Server

This is a Todo server based on FastMCP, designed for the Swarmonomicon project. The server receives todo requests via FastMCP and stores them in MongoDB for processing by Swarmonomicon todo workers.

🚀 Quick Start

This Fast MCP Todo Server is tailored for the Swarmonomicon project. It efficiently receives todo requests through FastMCP and stores them in MongoDB for subsequent processing by Swarmonomicon todo workers.

✨ Features

• FastMCP-based Server: Specifically designed to receive todo requests.
• MongoDB Integration: Utilizes MongoDB for reliable todo storage.
• Swarmonomicon Compatibility: Works seamlessly with Swarmonomicon todo workers.
• Python Implementation: Developed using Python for ease of use and maintenance.

📦 Installation

1. Clone the repository:

   git clone https://github.com/DanEdens/Omnispindle.git
   cd Omnispindle
   

2. Install uv (if not already installed):

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

3. Create and activate a virtual environment with uv:

   uv venv
   source .venv/bin/activate  # On Unix/macOS
   # Or
   .venv\Scripts\activate  # On Windows
   

4. Install dependencies using uv:

   uv pip install -r requirements.txt
   

5. For the development environment, install additional dependencies:

   uv pip install -r requirements-dev.txt
   

6. Create the configuration file .env:

   MONGODB_URI=mongodb://localhost:27017
   MONGODB_DB=swarmonomicon
   MONGODB_COLLECTION=todos
   

💻 Usage Examples

Basic Usage

Start the Server

1. Start the FastMCP server:

   python -m src.Omnispindle
   

Add a Todo

You can add todos using FastMCP in multiple ways:

1. Using the FastMCP Python client:

   from fastmcp import FastMCPClient
   
   client = FastMCPClient()
   response = await client.call_tool("add_todo", {
       "description": "Example todo",
       "priority": "high",  # Optional, default is "medium"
       "target_agent": "user"  # Optional, default is "user"
   })
   

2. Using MQTT directly:

   mosquitto_pub -t "mcp/todo/new" -m '{
       "description": "Example todo",
       "priority": "high",
       "target_agent": "user"
   }'
   

Advanced Usage

Run Tests

1. Run all tests:

   pytest tests/
   

2. Run tests with coverage:

   pytest --cov=src tests/
   

3. Run a specific test file:

   pytest tests/test_todo_handler.py -v
   

📚 Documentation

Integration with Swarmonomicon

This server is part of the larger Swarmonomicon project, which offers:

• Task Management and Allocation: Efficiently manages and distributes tasks.
• Agent-based Task Processing: Processes tasks using agents for better scalability.
• Real-time MQTT Updates: Provides real-time updates via MQTT.
• AI Model Integration: Integrates various AI models for enhanced functionality.

For more information about the Swarmonomicon project and its features, refer to the main project documentation.

📄 License

This project is licensed under the MIT License.

Contribution Guidelines

1. Fork the repository.
2. Create a feature branch.
3. Make your changes.
4. Add tests for new features.
5. Submit a pull request.

For more detailed information on contributing to the Swarmonomicon project, refer to the main project's contribution guidelines.