Toymcp

🚀 玩具MCP待辦事項列表服務器

這是一個基於MCP概念實現的簡單待辦事項列表管理工具，它通過JSON - RPC協議提供遠程過程調用（RPC）接口，能幫助用戶便捷地管理待辦事項。

🚀 快速開始

本項目是一個基於MCP概念的待辦事項列表管理工具，通過JSON - RPC協議提供RPC接口。以下是快速上手的相關步驟。

✨ 主要特性

• 基於MCP概念實現，功能簡單實用。
• 通過JSON - RPC協議提供遠程過程調用接口。
• 提供清潔啟動腳本，方便重新初始化數據庫和服務器環境。
• 具備完善的測試機制，包括單元測試、集成測試和覆蓋率報告。

📦 安裝指南

先決條件

• Node.js (建議使用版本16或更高)
• npm (建議使用版本7或更高)
• Docker (用於PostgreSQL容器化部署)

安裝步驟

1. 克隆倉庫

   git clone https://github.com/yourusername/toyMCP-todo.git
   cd toyMCP-todo
   

2. 安裝依賴

   npm install
   

3. 啟動PostgreSQL數據庫容器

   docker run -d --name todo-mcp-postgres -e POSTGRES_PASSWORD=yourpassword -p 5432:5432 postgres:latest
   

4. 初始化數據庫表結構

   npm run init-database
   

5. 啟動服務

   npm start
   

清潔啟動腳本

為方便重新初始化數據庫和服務器環境，項目提供了清潔啟動腳本：

npm run clean-start

此命令會自動清理數據庫、重建表結構並重啟服務。

💻 使用示例

測試

單元測試

運行單元測試以驗證核心功能是否正常工作：

npm test

集成測試

集成測試用於驗證各個模塊之間的協作：

npm run integration-test

覆蓋率報告

生成代碼覆蓋報告，幫助開發者瞭解測試的充分性：

npm run coverage

完成後，可在./coverage目錄下查看報告。

📚 詳細文檔

API文檔

方法列表

• mcp.discover：返回所有可用方法的信息。
• todo.add：添加一個新的待辦事項。
• todo.list：獲取所有的待辦事項。
• todo.remove：根據ID刪除指定的待辦事項。

請求與響應示例

發現方法（mcp.discover）

請求:

{
  "jsonrpc": "2.0",
  "method": "mcp.discover",
  "id": 1
}

響應:

{
  "jsonrpc": "2.0",
  "result": {
    "name": "玩具MCP待辦事項服務",
    "version": "1.0.0",
    "methods": [
      {
        "name": "mcp.discover",
        "params": {},
        "description": "返回所有可用方法的信息"
      },
      {
        "name": "todo.add",
        "params": {"text": "string"},
        "description": "添加一個新的待辦事項"
      }
    ]
  },
  "id": 1
}

添加待辦事項（todo.add）

請求:

{
  "jsonrpc": "2.0",
  "method": "todo.add",
  "params": {
    "text": "安裝Node.js"
  },
  "id": 1
}

響應:

{
  "jsonrpc": "2.0",
  "result": {
    "id": 1,
    "text": "安裝Node.js",
    "createdAt": "2024-03-15T12:34:56Z"
  },
  "id": 1
}

獲取所有待辦事項（todo.list）

請求:

{
  "jsonrpc": "2.0",
  "method": "todo.list",
  "id": 1
}

響應:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "id": 1,
      "text": "安裝Node.js",
      "createdAt": "2024-03-15T12:34:56Z"
    },
    {
      "id": 2,
      "text": "學習Docker",
      "createdAt": "2024-03-15T12:35:12Z"
    }
  ],
  "id": 1
}

刪除待辦事項（todo.remove）

請求:

{
  "jsonrpc": "2.0",
  "method": "todo.remove",
  // 此處原文未完整，推測後續應是 "params": {"id": 待刪除事項ID}, "id": 1 之類
}