mcp-server-shortcut

🚀 Shortcut.com MCP 服务器

本项目实现了Shortcut.com模型上下文协议（MCP）服务器，可用于访问和搜索Shortcut.com的票证，帮助用户更高效地与Shortcut.com票务管理系统进行交互。

🚀 快速开始

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

• 列出并搜索Shortcut中的故事（票证）
• 获取特定故事的详细信息
• 创建新故事
• 更新现有故事
• 向故事添加评论
• 检索工作流状态和项目

✨ 主要特性

• 支持Claude和其他MCP兼容的AI助手与Shortcut.com票务管理系统交互。
• 提供丰富的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
   激活 .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服务器实现
  • config.py - 配置管理
  • shortcut_client.py - Shortcut API的客户端
  • utils.py - 工具函数和数据模型
• requirements.txt - 项目依赖项
• .env - 环境变量文件

📄 许可证

[这里指定许可证，例如MIT或Apache]

👥 贡献者

• [你的名字] - 初始实现

📞 联系方式

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

此文档描述了如何设置和运行Shortcut.com的MCP服务器，并与Claude Desktop进行集成。