Fastmcp Todo

🚀 Quick MCP To-Do Server

A to-do server based on FastMCP for the Swarmonomicon project. This server receives to-do requests via FastMCP and stores them in MongoDB for processing by the Swarmonomicon to-do handler.

🚀 Quick Start

The Quick MCP To-Do Server is designed to receive to-do requests through FastMCP and store them in MongoDB. It's an essential part of the Swarmonomicon project.

✨ Features

• A FastMCP-based server for receiving to-do requests.
• Integrated with MongoDB for to-do storage.
• Compatible with the Swarmonomicon to-do handler.
• Implemented in Python.

📦 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 systems
   # Or on Windows
   .venv\Scripts\activate
   

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 a .env file and add configurations:

   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 To-Do Item

You can add to-do items via FastMCP in the following ways:

1. Use the FastMCP Python client:

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

2. Use MQTT directly:

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

Advanced Usage

Development Information

1. Run tests:

   pytest tests/
   

2. Run tests with coverage:

   coverage run -m pytest tests/ && coverage report
   

3. Specify a particular test file to run:

   pytest tests/test_example.py -v
   

📚 Documentation

This server plays a crucial role in the Swarmonomicon ecosystem. For more details, please refer to the main project documentation: Swarmonomicon.

📄 License

The licensing information for this project is provided here. Please refer to the relevant files for detailed information.

💡 Contribution Guide

Community contributions are welcome! If you'd like to participate, please refer to the project's contribution guide to learn how to submit issues, pull requests, and engage in development.