Shortcut

🚀 Shortcut.com MCP 服務器

本項目實現的模型上下文協議（MCP）服務器，可用於訪問和搜索 Shortcut.com 票務系統。它能讓 Claude 等支持 MCP 協議的人工智能助手與 Shortcut.com 票務管理系統進行交互，為票務管理帶來便利。

🚀 快速開始

本項目實現了與 Claude 和其他支持 MCP 協議的人工智能助手交互的 MCP 服務器，允許這些 AI 助手與 Shortcut.com 的票務管理系統進行交互。藉助此集成，AI 助手可執行以下操作：

• 列出和搜索 Shortcut 中的故事（票務）
• 獲取特定故事的詳細信息
• 創建新故事
• 更新現有故事
• 向故事添加評論
• 檢索工作流狀態和項目

✨ 主要特性

• 豐富的票務操作：支持對 Shortcut.com 票務系統中的故事進行列出、搜索、創建、更新、添加評論等操作。
• 便捷的集成方式：可與 Claude 等支持 MCP 協議的人工智能助手集成，實現自動化票務管理。
• 多樣化的功能接口：提供了多種 MCP 功能，包括資源訪問、工具調用和提示生成等。

📦 安裝指南

先決條件

• 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上或.venv\Scripts\activate在Windows上
   uv pip install -r requirements.txt
   
   # 使用pip
   python -m venv venv
   source venv/bin/activate  # 在Mac/Linux上或 venv\Scripts\activate 在 Windows 上
   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許可保護。