Milkosten Task MCP Server

🚀 タスクAPIサーバ - MCP TypeScript実装

このプロジェクトは、MCP（モデルコンテキストプロトコル）に基づくタスクAPIサーバです。標準入出力(STDIO)とHTTP + SSEの2つの方法で、AIツールやサービスとの相互作用をサポートしています。タスクの作成、読み取り、更新、削除が可能です。

🚀 クイックスタート

環境要件

• Node.js 14.0以上
• npm 6.0以上
• TypeScript 4.0以上

手順

1. プロジェクトをクローンします：

   git clone <repository-url>
   

2. 依存関係をインストールします：

   cd mcp-template-ts && npm install
   

3. サーバを起動します（STDIOモード）：

   npm start
   

4. または、HTTP + SSEサーバを起動します：

   npm run start:web
   

✨ 主な機能

コア機能

• タスク管理：CRUD操作（作成、読み取り、更新、削除）をサポートします。
• フィルター：状態、カテゴリ、優先度に基づいてタスクをフィルタリングできます。
• 非同期操作：HTTP + SSEサーバは長時間ポーリングをサポートし、タスクの状態をリアルタイムで返します。

統合

• MCPプロトコル：MCPプロトコルと互換性があり、AIツールやサービスとの統合が容易です。
• 外部タスクAPI：環境変数を設定することで、外部のタスク管理サービスを使用できます。

📦 インストール

環境変数

💻 使用例

基本的な使用法

listTasks

すべてのタスクをリストします。

const result = await client.callTool({
  name: "listTasks",
  arguments: {
    // オプションのフィルタ条件
    status: "pending", // 状態でフィルタリング
    category: "工作",  // カテゴリでフィルタリング
    priority: "high"   // 優先度でフィルタリング
  }
});

createTask

新しいタスクを作成します。

const result = await client.callTool({
  name: "createTask",
  arguments: {
    task: "完成项目报告",  // 必須：タスクの説明
    category: "工作",      // オプション：タスクのカテゴリ
    priority: "high"       // オプション：低、中、高
  }
});

updateTask

既存のタスクを更新します。

const result = await client.callTool({
  name: "updateTask",
  arguments: {
    taskId: 123,           // 必須：更新するタスクのID
    task: "更新后的描述",  // オプション：新しい説明
    status: "done",        // オプション：pending、started、done
    category: "个人",      // オプション：新しいカテゴリ
    priority: "medium"     // オプション：低、中、高
  }
});

deleteTask

タスクを削除します。

const result = await client.callTool({
  name: "deleteTask",
  arguments: {
    taskId: 123   // 必須：削除するタスクのID
  }
});

📚 ドキュメント

プロジェクト構造

mcp-template-ts/
├── dist/               # コンパイルされたJavaScriptファイル
├── src/                # TypeScriptソースコードファイル
│   ├── index.ts        # STDIOサーバのエントリーファイル
│   ├── http-server.ts  # HTTP + SSEサーバのエントリーファイル
│   ├── test-client.ts  # テストクライアントの実装
├── .env                # 環境変数の設定ファイル
├── package.json        # プロジェクトの依存関係管理ファイル
├── tsconfig.json       # TypeScriptコンパイルの設定ファイル
└── README.md           # プロジェクトのドキュメント

開発

1. TypeScriptコンパイラをリアルタイムで監視するように起動します：

   npm run watch
   

2. 変更を検証するためにテストを実行します：

   npm test
   

📄 ライセンス

このプロジェクトはMITライセンスの下で提供されています。詳細な条項は、LICENSEファイルを参照してください。

謝辞

• @modelcontextprotocol/sdkを使用してMCPプロトコルを実装しています。
• AIツールやサービスとの統合を目的としています。