Shortcut MCP

Shortcut.com MCP服务器

用于访问和搜索Shortcut.com上的票证的模型上下文协议（MCP）服务器的实现。

概述

该项目实现了一个MCP服务器，允许Claude和其他兼容MCP的AI助手与Shortcut.com的票务管理系统进行交互。通过这种集成，AI助手可以：

• 在快捷方式中列出和搜索故事（门票）
• 获取特定故事的详细信息
• 创建新故事
• 更新现有故事
• 为故事添加评论
• 检索工作流状态和项目

先决条件

• Python 3.10+
• Shortcut.com API代币

安装

1. 克隆此存储库：

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

1. 创建虚拟环境并安装依赖项：

   # Using uv (recommended)
   curl -LsSf https://astral.sh/uv/install.sh | sh  # For Mac/Linux
   uv venv
   source .venv/bin/activate  # On Mac/Linux or .venv\Scripts\activate on Windows
   uv pip install -r requirements.txt

   # Using pip
   python -m venv venv
   source venv/bin/activate  # On Mac/Linux or venv\Scripts\activate on Windows
   pip install -r requirements.txt

1. 创建一个 .env 项目根目录中带有快捷方式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桌面

要将此MCP服务器与Claude Desktop一起使用：

1. 编辑Claude Desktop配置文件：

- 雨衣： ~/Library/Application Support/Claude/claude_desktop_config.json - 窗户： %APPDATA%\Claude\claude_desktop_config.json

1. 添加MCP服务器配置：

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

1. 重新启动克劳德桌面。

可用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 -快捷方式API的客户端 - utils.py -效用函数和数据模型

• requirements.txt -项目依赖关系
• .env -环境变量（未在git中跟踪）

发展

添加新功能

要向MCP服务器添加新功能，请执行以下操作：

1. 将任何新的API方法添加到 shortcut_client.py
2. 在中定义Pydantic模型 utils.py 如有需要
3. 在中使用装饰器实现MCP功能 server.py:

- 使用 @mcp.resource() 对于只读资源 - 使用 @mcp.tool() 用于可以修改数据的操作 - 使用 @mcp.prompt() 用于生成模板或结构化文本

贡献

欢迎投稿！请随时提交拉取请求。

许可证

MIT许可证