Omnispindle

🚀 快速 MCP 待辦事項服務器

這是一個基於 FastMCP 的待辦事項服務器，專為 Swarmonomicon 項目打造。該服務器藉助 FastMCP 接收待辦事項請求，並將這些請求存儲於 MongoDB 中，以供 Swarmonomicon 待辦事項工作者進行處理。

🚀 快速開始

此服務器是基於 FastMCP 的待辦事項服務器，主要用於接收待辦事項請求，並將其存儲在 MongoDB 中，供 Swarmonomicon 待辦事項工作者處理。以下是使用該服務器的基本步驟：

✨ 主要特性

• 基於 FastMCP 的服務器，可高效接收待辦事項請求。
• 集成 MongoDB，實現待辦事項的可靠存儲。
• 與 Swarmonomicon 待辦事項工作者完美兼容。
• 採用 Python 實現，便於開發和維護。

📦 安裝指南

1. 克隆倉庫：

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

2. 安裝 uv（若尚未安裝）：

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

3. 創建並激活帶有 uv 的虛擬環境：

   uv venv
   source .venv/bin/activate  # 在 Unix/macOS 上
   # 或者
   .venv\Scripts\activate  # 在 Windows 上
   

4. 使用 uv 安裝依賴項：

   uv pip install -r requirements.txt
   

5. 若為開發環境，請安裝額外的依賴項：

   uv pip install -r requirements-dev.txt
   

6. 創建配置文件 .env：

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

💻 使用示例

基礎用法

啟動服務器

啟動 FastMCP 服務器：

python -m src.Omnispindle

添加 Todo

您可以通過多種方式使用 FastMCP 添加待辦事項：

• 使用 FastMCP Python 客戶端：

from fastmcp import FastMCPClient

client = FastMCPClient()
response = await client.call_tool("add_todo", {
    "description": "Example todo",
    "priority": "high",  # 可選，默認為 "medium"
    "target_agent": "user"  # 可選，默認為 "user"
})

• 直接使用 MQTT：

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

高級用法

開發

• 運行測試：

pytest tests/

• 帶覆蓋率運行測試：

pytest --cov=src tests/

• 運行特定的測試文件：

pytest tests/test_todo_handler.py -v

📚 詳細文檔

此服務器是更大的 Swarmonomicon 項目的一部分，該項目提供以下功能：

• 任務管理和分配
• 基於代理的任務處理
• 即時 MQTT 更新
• 集成各種 AI 模型

有關 Swarmonomicon 項目及其功能的更多信息，請參閱 主要項目的文檔。

📄 許可證

本項目採用 MIT 許可證。

貢獻指南

1. 叉克倉庫
2. 創建功能分支
3. 進行修改
4. 為新功能添加測試
5. 提交拉取請求

有關貢獻到 Swarmonomicon 項目的更多詳細信息，請參閱 主要項目的貢獻指南。