Teamwork MCP

🚀 チームワーク MCP プロジェクトドキュメント

Teamwork MCP は、Teamwork.com プラットフォームと統合するためのツールです。Cursor などの MCP クライアントをサポートすることを目的としています。このプロジェクトは TypeScript で記述されており、Teamwork のプロジェクト、タスク、その他のリソースを相互作用および管理するための豊富な API メソッドを提供します。

🚀 クイックスタート

Teamwork MCP は、Teamwork.com プラットフォームとの統合を容易にするツールです。以下のセクションでは、インストール方法や使用方法について説明します。

✨ 主な機能

• Teamwork.com プラットフォームとの統合をサポート
• MCP クライアント（Cursor など）に対応
• TypeScript で記述され、豊富な API メソッドを提供

📦 インストール

NPX を使用する（推奨）

最も簡単な使用方法は、NPX を通じて実行することです：

npx teamwork-mcp

また、構成オプションを渡して実行することもできます：

npx teamwork-mcp --domain=your-company --user=your-email@example.com --pass=your-password

アプリケーションをビルドする

注意：MCP を使用するだけの場合は、NPX コマンドを直接使用して、ビルドする必要はありません。

アプリケーションをビルドするには：

npm run build

これにより、TypeScript コードがコンパイルされ、MCP サーバーとして実行できるようになります。

MCP サーバーを実行する

このプロジェクトを MCP サーバーとして実行する場合（他のアプリケーションとの統合に使用する）：

ユーザー名、パスワード、URL を .env ファイルに保存するか、環境変数として設定していると仮定します：

node C:/your-full-path/build/index.js

または、コマンドライン引数を渡すこともできます：

node C:/your-full-path/build/index.js --teamwork-domain=your-company --teamwork-username=your-email@example.com --teamwork-password=your-password

短縮形を使用することもできます：

node C:/your-full-path/build/index.js --domain=your-company --user=your-email@example.com --pass=your-password

MCP チェックツールを使用する（デバッグ用）

デバッグのために MCP チェックツールを実行するには：

npm run inspector

📚 ドキュメント

Teamwork プロジェクトを構成する

あなたのソリューションを Teamwork プロジェクトに関連付けるには、プロジェクトのルートディレクトリに .teamwork ファイルを作成し、以下の構造にすることができます：

PROJECT_ID = YourTeamworkProjectID

この構成ファイルは、あなたのソリューションが対応する Teamwork プロジェクトを識別するために使用されます。将来的には、より詳細な情報が追加される可能性があります。構成が完了すると、MCP は自動的にあなたのプロジェクトを識別し、プロジェクトと関連するタスクを取得するために必要な API 呼び出しの数を減らすことができます。

使用方法

Cursor（およびその他の MCP クライアント）に追加する

Cursor の早期バージョン（0.47 未満）を使用している場合：

1. Cursor の設定 > 機能 > MCP を開きます。
2. 「+ 新しい MCP サーバーを追加」をクリックします。
3. サーバー名を入力します（例：「Teamwork API」）。
4. 転送タイプを「stdio」に選択します。
5. コマンドラインでサーバーを実行するコマンドを入力します：npx @vizioz/teamwork-mcp を入力し、必要な資格情報とドメインのコマンドライン引数を追加します。
   • --allow=getProjects,getTasks または --deny=deleteTask などのオプションでツールをフィルタリングすることができます。
6. 「追加」をクリックします。

Cursor のバージョン 0.47 以上を使用している場合（手動で構成ファイルを編集する）：

    "Teamwork": {
      "command": "npx",
      "args": [
        "-y",
        "@vizioz/teamwork-mcp",
        "--domain",
        "yourdomain",
        "--user",
        "youruser@yourdomain.com",
        "--pass",
        "yourPassword"
      ]
    }

ツールのフィルタリングオプションを追加したい場合は、次のようにすることができます：

    "Teamwork": {
      "command": "npx",
      "args": [
        "-y",
        "@vizioz/teamwork-mcp",
        "--domain",
        "yourdomain",
        "--user",
        "youruser@yourdomain.com",
        "--pass",
        "yourPassword",
        "--allow",
        "Tasks,Projects",
        "--deny",
        "getProjectsPeopleMetricsPerformance,getProjectsPeopleUtilization"
      ]
    }

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。

⚠️ 重要提示

このプロジェクトは例示目的のみで提供されています。使用する前に、関連するドキュメントと条項をよく読んでください。