Task MCP Server

🚀 Task Manager Implementation for Task API Interface

This project is a task manager based on the MCP protocol, supporting task management and operations through two different interfaces (command-line interface and network interface). You can use it to create, update, query, and delete tasks.

🚀 Quick Start

This project is a task manager based on the MCP protocol. It supports managing and operating tasks through two different interfaces: the command-line interface and the network interface. You can use it to create, update, query, and delete tasks.

✨ Features

• Task Creation: Allows users to add new tasks.
• Task Query: Can filter the task list based on status, category, or priority.
• Task Update: Supports modifying the details of existing tasks.
• Task Deletion: Allows removing tasks that are no longer needed.

📦 Installation

Prerequisites

• Node.js (Recommended version: 14.0+)
• npm/yarn package manager
• Environment variable configuration file (.env)

Installation Steps

1. Download and install Node.js and npm.
2. Clone the project repository to your local machine:

   git clone https://github.com/yourusername/mcp-task.git
   

3. Navigate to the project directory:

   cd mcp-task
   

4. Install the dependencies:

   npm install
   

Environment Variable Configuration

Edit the project's .env file and add the following content:

TASK_MANAGER_API_BASE_URL=Your Task API Address  # Required
TASK_MANAGER_API_KEY=Your API Key               # Required
TASK_MANAGER_HTTP_PORT=3000                     # Optional, default is 3000
PORT=Other Port Name                            # Optional, higher priority than TASK_MANAGER_HTTP_PORT

💻 Usage Examples

Command-Line Interface (STDIO)

Suitable for use in the terminal for quick task management operations. For example:

node index.js --list  # List all tasks
node index.js --create "Complete the project report"  # Create a new task

Network Interface (HTTP + SSE)

Supports interaction via the HTTP protocol and SSE (Server-Sent Events), suitable for building web applications. For example:

// Use the fetch API to create a task
fetch('http://localhost:3000/api/tasks', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    task: "Complete the project report"
  })
});

Command-Line Tool (STDIO)

List Tasks (listTasks)

node index.js --list [--status Status] [--category Category] [--priority Priority]

• --status: Optional, status includes: "Incomplete", "In Progress", "Completed"
• --category: Optional, categories include: "Work", "Study", "Life"
• --priority: Optional, priorities include: "Low", "Medium", "High"

Create Task (createTask)

node index.js --create <Task Name>

Update Task (updateTask)

node index.js --update <Task ID> [--status Status] [--category Category] [--priority Priority]

Delete Task (deleteTask)

node index.js --delete <Task ID>

Network Interface (HTTP + SSE)

All API requests require authentication. The following are common API endpoints:

• Create Task:

  POST /api/tasks
  Content-Type: application/json
  
  {
    "task": "Complete the project report"
  }
  

• Query Tasks:

  GET /api/tasks?status=Incomplete&category=Work&priority=High
  

• Update Task:

  PUT /api/tasks/{taskId}
  Content-Type: application/json
  
  {
    "status": "In Progress",
    "category": "Work",
    "priority": "High"
  }
  

• Delete Task:

  DELETE /api/tasks/{taskId}
  

📚 Documentation

Project Structure

mcp-task/
├── dist/               # Directory for compiled JavaScript files
├── src/                # Directory for TypeScript source code
│   ├── index.ts        # Entry file for the STDIO server
│   ├── http-server.ts  # Entry file for the HTTP + SSE server
│   └── test-client.ts  # Implementation of the test client
├── .env                # Environment variable configuration file
├── package.json       # Project dependency management file
├── tsconfig.json      # TypeScript compiler configuration file
└── README.md          # Project documentation

Development Guide

1. Start the development environment:

   npm run watch
   

   This will monitor the source code files in real-time and automatically compile them.
2. Run tests:

   npm test
   

   Execute all predefined test cases to ensure the functionality is working properly.
3. Build the project:

   npm run build
   

   Generate optimized production version files in the dist/ directory.

📄 License

This project is licensed under the MIT License.

Acknowledgments

Thanks to the following projects for their contributions:

• MCP Protocol - Provides the communication standard.
• TypeScript - Used for writing strongly typed code.