MCP Server Shortcut

🚀 Shortcut.com MCP 服務器

本項目實現了Shortcut.com 模型上下文協議（MCP）服務器，可用於訪問和搜索Shortcut.com 的票證。藉助該服務器，能讓Claude 等MCP 兼容的AI 助手與Shortcut.com 票務管理系統進行交互，提升票務管理效率。

🚀 快速開始

環境準備

確保你的環境滿足以下先決條件：

• 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
   激活 .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。

✨ 主要特性

此項目實現了與Shortcut.com 票務管理系統交互的MCP 服務器。通過這個集成，支持Claude 和其他MCP 兼容的AI 助手可以：

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

💻 使用示例

基礎用法

以下是一些可用的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 服務器實現
  • config.py - 配置管理
  • shortcut_client.py - Shortcut API 的客戶端
  • utils.py - 工具函數和數據模型
• requirements.txt - 項目依賴項
• .env - 環境變量文件

貢獻者

• [你的名字] - 初始實現

聯繫方式

• 郵件：[your.email@example.com]
• GitHub：@yourusername

📄 許可證

[這裡指定許可證，例如MIT 或Apache]