Milkosten Task MCP Server

🚀 Task API Server - MCP TypeScript Implementation

This project is a task API server based on the MCP (Model Context Protocol), which supports interactions with AI tools and services through two methods: standard input/output (STDIO) and HTTP + SSE. It allows for creating, reading, updating, and deleting tasks.

🚀 Quick Start

Environment Requirements

• Node.js version 14.0 or higher
• npm version 6.0 or higher
• TypeScript version 4.0 or higher

Steps

1. Clone the project:

   git clone <repository-url>
   

2. Install dependencies:

   cd mcp-template-ts && npm install
   

3. Start the server (STDIO mode):

   npm start
   

4. Or start the HTTP + SSE server:

   npm run start:web
   

✨ Features

Core Features

• Task Management: Supports CRUD operations (Create, Read, Update, Delete).
• Filters: Allows filtering tasks by status, category, and priority.
• Asynchronous Operations: The HTTP + SSE server supports long polling and returns task status in real-time.

Integration

• MCP Protocol: Compatible with the MCP protocol for easy integration with AI tools and services.
• External Task API: An external task management service can be used by configuring environment variables.

📦 Installation

Environment Variables

💻 Usage Examples

listTasks

List all tasks.

const result = await client.callTool({
  name: "listTasks",
  arguments: {
    // Optional filtering conditions
    status: "pending", // Filter by status
    category: "work",  // Filter by category
    priority: "high"   // Filter by priority
  }
});

createTask

Create a new task.

const result = await client.callTool({
  name: "createTask",
  arguments: {
    task: "Complete the project report",  // Required: Task description
    category: "work",      // Optional: Task category
    priority: "high"       // Optional: Low, medium, high
  }
});

updateTask

Update an existing task.

const result = await client.callTool({
  name: "updateTask",
  arguments: {
    taskId: 123,           // Required: ID of the task to be updated
    task: "Updated description",  // Optional: New description
    status: "done",        // Optional: pending, started, done
    category: "personal",  // Optional: New category
    priority: "medium"     // Optional: Low, medium, high
  }
});

deleteTask

Delete a task.

const result = await client.callTool({
  name: "deleteTask",
  arguments: {
    taskId: 123   // Required: ID of the task to be deleted
  }
});

📚 Documentation

Project Structure

mcp-template-ts/
├── dist/               # Compiled JavaScript files
├── src/                # TypeScript source code files
│   ├── 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 compilation configuration file
└── README.md           # Project documentation

Development

1. Start the TypeScript compiler for real-time monitoring:

   npm run watch
   

2. Run tests to verify changes:

   npm test
   

📄 License

This project is licensed under the MIT license. Please refer to the LICENSE file for specific terms.

Acknowledgments

• Uses @modelcontextprotocol/sdk to implement the MCP protocol.
• Aims to integrate with AI tools and services.