Toymcp

🚀 玩具MCP待办事项列表サーバー

このサーバーは、MCP概念に基づいて実装されたシンプルな待办事项リスト管理ツールです。JSON - RPCプロトコルを通じて、リモートプロシージャコール（RPC）インターフェースを提供します。

🚀 クイックスタート

✨ 主な機能

• MCP概念に基づく待办事项リスト管理
• JSON - RPCプロトコルを使用した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

このコマンドは、データベースを自動的にクリーンアップし、テーブル構造を再構築し、サービスを再起動します。

💻 使用例

基本的な使用法

以下は、APIを使用して待办事项を管理する基本的な例です。

📚 ドキュメント

テスト

単体テスト

コア機能が正常に動作することを検証するために単体テストを実行します。

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",
  // ここに削除する待办事项のIDを指定する
  "params": {
    "id": 1
  },
  "id": 1
}