Shortcut

🚀 Shortcut.com MCPサーバー

このプロジェクトは、Shortcut.comのチケットシステムをアクセスおよび検索するためのモデルコンテキストプロトコル（MCP）サーバーの実装です。Claudeやその他のMCPプロトコルをサポートするAIアシスタントが、Shortcut.comのチケット管理システムとやり取りできるようになります。

🚀 クイックスタート

このMCPサーバーを使用することで、ClaudeなどのAIアシスタントがShortcut.comのチケット管理システムと連携できます。以下の手順でセットアップしてください。

✨ 主な機能

• Shortcut内のストーリー（チケット）を一覧表示および検索
• 特定のストーリーの詳細情報を取得
• 新しいストーリーを作成
• 既存のストーリーを更新
• ストーリーにコメントを追加
• ワークフローの状態とプロジェクトを取得

📦 インストール

前提条件

• Python 3.10+
• Shortcut.com APIトークン

インストール手順

1. このリポジトリをクローンします：

   git clone https://github.com/yourusername/mcp-server-shortcut.git
   cd mcp-server-shortcut
   

2. 仮想環境を作成し、依存関係をインストールします：

   # uvを使用する場合（推奨）
   curl -LsSf https://astral.sh/uv/install.sh | sh  # Mac/Linuxの場合
   uv venv
   source .venv/bin/activate  # Mac/Linuxでのアクティベート、Windowsでは.venv\Scripts\activate
   uv pip install -r requirements.txt
   
   # pipを使用する場合
   python -m venv venv
   source venv/bin/activate  # Mac/Linuxでのアクティベート、Windowsではvenv\Scripts\activate
   pip install -r requirements.txt
   

3. プロジェクトのルートディレクトリに.envファイルを作成し、Shortcut APIトークンを追加します：

   SHORTCUT_API_TOKEN=your_token_here
   SERVER_PORT=5000
   SERVER_HOST=0.0.0.0
   DEBUG_MODE=True
   

💻 使用例

サーバーの起動

以下のコマンドでMCPサーバーを起動します：

python -m src.server

Claude Desktopの設定

このMCPサーバーをClaude Desktopと一緒に使用するには、以下の手順を実行します：

1. Claude Desktopの設定ファイルを編集します：

   • Mac: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json

2. MCPサーバーの設定を追加します：

   {
     "mcpServers": {
       "shortcut": {
         "command": "python",
         "args": ["-m", "src.server"],
         "env": {
           "SHORTCUT_API_TOKEN": "your_token_here"
         }
       }
     }
   }
   

3. Claude Desktopを再起動します。

利用可能なMCP機能

リソース

• shortcut://stories - ストーリーの一覧にアクセス
• shortcut://story/{story_id} - 特定のストーリーにアクセス

ツール

• list_stories - オプションのフィルター付きでストーリーを一覧表示
• search_stories - テキストクエリを使用してストーリーを検索
• get_story_details - 特定のストーリーの詳細情報を取得
• create_story - 新しいストーリーを作成
• update_story - 既存のストーリーを更新
• add_comment - ストーリーにコメントを追加
• list_workflow_states - すべてのワークフロー状態を一覧表示
• list_projects - すべてのプロジェクトを一覧表示

プロンプト

• create_bug_report - バグレポートのテンプレートを生成
• create_feature_request - 機能リクエストのテンプレートを生成

📚 ドキュメント

プロジェクト構造

• src/ - ソースコードのディレクトリ
  • server.py - MCPサーバーのメインファイル
  • client.py - MCPサーバーとやり取りするためのサンプルクライアントコード
  • config.py - 設定と環境変数
  • requirements.txt - プロジェクトに必要なPythonの依存関係

開発

このプロジェクトに新しい機能を追加するには、以下の手順に従ってください：

1. リポジトリをクローンし、ローカル環境に依存関係をインストールします。
2. 必要な機能を追加するためにコードを変更します。
3. 変更をテストし、すべての既存の機能が正常に動作することを確認します。
4. 変更をコミットし、プルリクエストを作成します。

貢献

コミュニティからの貢献を歓迎します！問題を見つけた場合や改善提案がある場合は、イシューまたはプルリクエストを提出してください。貢献方法については、貢献ガイドを参照してください。

📄 ライセンス

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