Toymcp

🚀 Toy MCP To-Do List Server

This is a simple to-do list management tool implemented based on the MCP concept. It provides a Remote Procedure Call (RPC) interface through the JSON-RPC protocol.

🚀 Quick Start

✨ Features

• A simple to-do list management tool based on the MCP concept.
• Provides a Remote Procedure Call (RPC) interface through the JSON-RPC protocol.

📦 Installation

Prerequisites

• Node.js (version 16 or higher is recommended)
• npm (version 7 or higher is recommended)
• Docker (for containerized deployment of PostgreSQL)

Installation Steps

1. Clone the repository

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

2. Install dependencies

   npm install
   

3. Start the PostgreSQL database container

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

4. Initialize the database table structure

   npm run init-database
   

5. Start the service

   npm start
   

Clean Start Script

To facilitate re-initializing the database and server environment, the project provides a clean start script:

npm run clean-start

This command will automatically clean the database, rebuild the table structure, and restart the service.

💻 Usage Examples

Testing

Unit Tests

Run unit tests to verify that the core functions are working properly:

npm test

Integration Tests

Integration tests are used to verify the collaboration between various modules:

npm run integration-test

Coverage Report

Generate a code coverage report to help developers understand the sufficiency of testing:

npm run coverage

After completion, you can view the report in the ./coverage directory.

📚 Documentation

API Documentation

Method List

• mcp.discover: Returns information about all available methods.
• todo.add: Adds a new to-do item.
• todo.list: Retrieves all to-do items.
• todo.remove: Deletes a specified to-do item by ID.

Request and Response Examples

Discover Methods (mcp.discover)

Request:

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

Response:

{
  "jsonrpc": "2.0",
  "result": {
    "name": "Toy MCP To-Do Service",
    "version": "1.0.0",
    "methods": [
      {
        "name": "mcp.discover",
        "params": {},
        "description": "Returns information about all available methods"
      },
      {
        "name": "todo.add",
        "params": {"text": "string"},
        "description": "Adds a new to-do item"
      }
    ]
  },
  "id": 1
}

Add a To-Do Item (todo.add)

Request:

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

Response:

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

Get All To-Do Items (todo.list)

Request:

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

Response:

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

Delete a To-Do Item (todo.remove)

Request:

{
  "jsonrpc": "2.0",
  "method": "todo.remove",
  // The original content seems incomplete here, assuming it should have params like {"id": 1}
  "params": {"id": 1},
  "id": 1
}